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

Merge pull request #23 from LJNeon/contributing

Browse source 
Fix CONTRIBUTING.md
This commit is contained in:
Alt 2022-10-02 00:31:52 +02:00 • committed by GitHub
commit 9fbe101203
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CONTRIBUTING.md
View file

@ -3,20 +3,24 @@
Thanks for considering contributing! This project would not be what it is without the support of the community. Thanks for considering contributing! This project would not be what it is without the support of the community.
## Issues ## Issues
- If reporting a bug, please include the operating system used, any relevant information about the tech stack, and the configuration used. - If reporting a bug, please include the operating system used, any relevant information about the tech stack, and the configuration used.
## Pull requests ## Pull requests
- Before opening the PR, make sure you've built and run it, done the tests locally, and run the formatter/linter. - 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. - 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. - If possible, check that someone else hasn't recently said that they've taken up an issue.
- Try to keep your PR focused on a single feature/bug/etc, don't mix them together.
- 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: ## How to create and use a fork:
1. Fork this project. 1. Fork this project.
2. Clone your fork: `git clone <fork>`. 2. Clone your fork: `git clone <fork>`.
3. Add a remote for this project: `git remote add upstream <url>`. 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: 4. Your fork is ready to go, to create a pull request you can:
- Make sure you're starting from `main`: `git switch main`. - Make sure you're starting from `main`: `git switch main`.
- Grab any new commits: `git pull upstream dev`. - Grab any new commits: `git pull upstream dev`.
- Create a new brancch: `git switch -c <new-branch>`. - Create a new branch: `git switch -c <new-branch>`.
- And you're good to go! - And you're good to go!