diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index f9e2168..6a11504 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -5,6 +5,27 @@ If you want to contribute to neocord, feel free to fork the repo and submit a pr when you're done with something. Please do not use a formatter but try to stick to the formatting of other files. Prettier will be introduced at a later date, same goes for eslint. +## Setup + +First, fork the neocord repository so you are able to make pull requests. Then, clone your fork: +``` +git clone https://github.com/{you-user}/neocord.git +``` + +Keep up to date on your fork: +``` +cd neocord +git checkout main +git pull https://github.com/neo-cord/neocord.git main +``` + +Building the code: +``` +cd neocord +yarn +``` +Now your ready to code your mind away! (Please read the [Format](https://github.com/neo-cord/neocord/blob/master/.github/CONTRIBUTING.md#format) section before making pull requests!). + ## Commits **Make sure to use [this formatting](https://gitmoji.carloscuesta.me/) for commit emojis or your pr won't get merged.**