|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Feel free to dive in! [Open](https://github.com/sablier-labs/docs/issues/new) an issue, |
| 4 | +[start](https://github.com/sablier-labs/docs/discussions/new/choose) a discussion or submit a PR. For any informal |
| 5 | +concerns or feedback, please join our [Discord server](https://discord.gg/bSwRCwWRsT). |
| 6 | + |
| 7 | +Contributions to Sablier Docs are welcome by anyone interested in improving readability, or adding new features. |
| 8 | + |
| 9 | +## Pre Requisites |
| 10 | + |
| 11 | +You will need the following software on your machine: |
| 12 | + |
| 13 | +- [Git] (https://git-scm.com/downloads) |
| 14 | +- [Node.Js] (https://nodejs.org/en/download/) |
| 15 | +- [Bun] (https://bun.sh/) |
| 16 | + |
| 17 | +### Set Up |
| 18 | + |
| 19 | +Clone this repository: |
| 20 | + |
| 21 | +```shell |
| 22 | +$ git clone [email protected]:sablier-labs/docs.git && cd docs |
| 23 | +``` |
| 24 | + |
| 25 | +Then, inside the project's directory, run this to install the Node.js dependencies: |
| 26 | + |
| 27 | +```shell |
| 28 | +$ bun install |
| 29 | +``` |
| 30 | + |
| 31 | +Create a new branch and switch to it, this is where all development work should be done: |
| 32 | + |
| 33 | +```shell |
| 34 | +$ git switch <name-of-branch> |
| 35 | +``` |
| 36 | + |
| 37 | +Now you can start making changes. |
| 38 | + |
| 39 | +Run the following command to starts a local development server and opens up a browser window. |
| 40 | + |
| 41 | +```shell |
| 42 | +$ bun run start |
| 43 | +``` |
| 44 | + |
| 45 | +To see a list of all available scripts: |
| 46 | + |
| 47 | +```shell |
| 48 | +$ bun run |
| 49 | +``` |
| 50 | + |
| 51 | +## Pull Requests |
| 52 | + |
| 53 | +- Before you submit your Pull Request (PR), search the project for an open or closed PR related to your submission to |
| 54 | + avoid duplicating effort. |
| 55 | +- Make your changes in a new git branch. |
| 56 | +- Commit your changes. Your commit message should follow the |
| 57 | + [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification |
| 58 | +- Make sure `bun run check` passes. |
| 59 | +- Open a pull request from your forked repository to the original repository. |
| 60 | + |
| 61 | +When making a pull request, ensure that: |
| 62 | + |
| 63 | +- A descriptive summary of the PR has been provided. |
| 64 | + |
| 65 | +## Integration with VSCode: |
| 66 | + |
| 67 | +Install the following VSCode extensions: |
| 68 | + |
| 69 | +- [code-spell-checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) |
| 70 | +- [vscode-tree-language](https://marketplace.visualstudio.com/items?itemName=CTC.vscode-tree-extension) |
0 commit comments