From d573f1a93b7044f0982bec71b9816b38c14f9b4a Mon Sep 17 00:00:00 2001 From: LJNeon <23249107+LJNeon@users.noreply.github.com> Date: Sat, 1 Oct 2022 13:58:08 -0700 Subject: [PATCH 1/3] Add CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..04012fc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,12 @@ +# Contributing + +Thanks for considering contributing! This project would not be what it is without the support of the community. + +## Issues +- If reporting a bug, please include the operating system used, any relevant information about the tech stack, and the configuration used. + +## Pull requests +- Code contributions should match the existing code style. +- Discuss additions/changes with us [on Discord](https://discord.gg/Dq43JNys6J) before working on them. +- Check to make sure someone hasn't worked on the same thing already. +- Make pull requests from a feature branch on your own fork instead of from `main`. \ No newline at end of file From 2fa5636651258cb2ef5ddbd5d3a8d971727376a5 Mon Sep 17 00:00:00 2001 From: LJNeon <23249107+LJNeon@users.noreply.github.com> Date: Sat, 1 Oct 2022 14:56:36 -0700 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 04012fc..90865b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ Thanks for considering contributing! This project would not be what it is withou - If reporting a bug, please include the operating system used, any relevant information about the tech stack, and the configuration used. ## Pull requests -- Code contributions should match the existing code style. -- Discuss additions/changes with us [on Discord](https://discord.gg/Dq43JNys6J) before working on them. -- Check to make sure someone hasn't worked on the same thing already. +- 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 From 9519cfe4baf9a5842d4713b0713591d3101dc63a Mon Sep 17 00:00:00 2001 From: LJNeon <23249107+LJNeon@users.noreply.github.com> Date: Sat, 1 Oct 2022 15:13:27 -0700 Subject: [PATCH 3/3] Add simple PR guide --- CONTRIBUTING.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) 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