diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 90865b7..7540f58 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,4 +9,14 @@ Thanks for considering contributing! This project would not be what it is withou - Before opening the PR, make sure you've built and run it, done the tests locally, and run the formatter/linter. - Feel free to pop in on [Discord](https://discord.gg/Dq43JNys6J) to ask for help or clarification on anything related to this project. - If possible, check that someone else hasn't recently said that they've taken up an issue. -- Make pull requests from a feature branch on your own fork instead of from `main`. \ No newline at end of file +- Make pull requests from a feature branch on your own fork instead of from `main`. + +## How to create and use a fork: +1. Fork this project. +2. Clone your fork: `git clone `. +3. Add a remote for this project: `git remote add upstream `. +4. Your fork is ready to go, to create a pull request you can: + - Make sure you're starting from `main`: `git switch main`. + - Grab any new commits: `git pull upstream dev`. + - Create a new brancch: `git switch -c `. + - And you're good to go! \ No newline at end of file