Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): contributing guide #63

Closed
wants to merge 10 commits into from
31 changes: 31 additions & 0 deletions apps/docs/docs/Reference/contributing/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contributing

Thanks for your consideration to contribute to Disploy 💙
We respect and appreciate all contributions, no matter how large or small.

## Projects

The Disploy ecosystem includes a number of repositories within the [Disploy](https://github.com/Disploy) organisation.
tristancamejo marked this conversation as resolved.
Show resolved Hide resolved

When it comes to contributions, repositories vary in scope, use different programming languages, and have varying levels of difficulty.

Here's a quick comparison to help you decide which repository might be the best to start contributing to (and/or is of interest to you):

<!-- | Repository | Scope | Language | Difficulty |
| -------------------------------------------------------------------------------- | ----- | ---------- | ---------- |
| [disploy](https://github.com/Disploy/disploy/tree/main/packages/disploy) | Core | TypeScript | Easy |
| [disploy/cli](https://github.com/Disploy/disploy/tree/main/packages/disploy/cli) | CLI | TypeScript | Hard | -->

### [`disploy`]

The core of Disploy, written in TypeScript. This package is responsible for the core functionality of Disploy, think of it as the "engine" of Disploy. If you come from a web development background, this is the equivalent of the React library, but it also includes a framework that would be the equivalent of Next.js. This package is the most important package in the Disploy ecosystem, and is the one that is most likely to be used by the majority of users.
tristancamejo marked this conversation as resolved.
Show resolved Hide resolved

### [`disploy/cli`]

This package, is not a "real package" it lives in a folder of the [`deploy`] package since it interfaces with the core and wouldn't make sense to be a separate package. This package is responsible for the CLI of Disploy, it's written in TypeScript and is the package that is used to run the `disploy` command in your terminal. The main purpose of this package is to bundle bots made with Disploy into a single ["entry point"] that can be either imported with a [standalone "entry point"] or deployed straight to Cloudflare Workers with a ["entry point" made for Cloudflare Workers]. It's completely [optional](/docs/Reference/framework-less/) to use this package, but it's highly recommended since it makes it easier to deploy your bots.
tristancamejo marked this conversation as resolved.
Show resolved Hide resolved

[`disploy`]: https://github.com/Disploy/disploy/tree/main/packages/disploy
[`disploy/cli`]: https://github.com/Disploy/disploy/tree/main/packages/disploy/cli
["entry point"]: https://github.com/Disploy/disploy/tree/main/packages/disploy/cli/assets/code
[standalone "entry point"]: https://github.com/Disploy/disploy/blob/main/packages/disploy/cli/assets/code/standaloneEntry.js
["entry point" made for cloudflare workers]: https://github.com/Disploy/disploy/blob/main/packages/disploy/cli/assets/code/cfWorkerEntry.js
tristancamejo marked this conversation as resolved.
Show resolved Hide resolved