rowan/bitburner-filesync
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add simple PR guide

Browse source
This commit is contained in:
LJNeon 2022-10-01 15:13:27 -07:00
parent 2fa5636651
commit 9519cfe4ba
No known key found for this signature in database
GPG key ID: 837C6B23D22030BE
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -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`.
- 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 <fork>`.
3. Add a remote for this project: `git remote add upstream <url>`.
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 <new-branch>`.
- And you're good to go!