diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d22ebbd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# Contributing + +Thanks for considering contributing to Scheduler-V2! + +## Opening issues + +If you find a bug, please feel free to [open an issue](https://github.com/swat-sccs/scheduler-v2/issues). + +If you taking the time to mention a problem, even a seemingly minor one, it is greatly appreciated, and a totally valid contribution to this project. Thank you! + +## Fixing bugs + +We love pull requests. Here’s a quick guide: + +1. [Fork this repository](https://github.com/swat-sccs/scheduler-v2/fork) and then clone it locally: + + ```bash + git clone --recursive https://github.com/swat-sccs/scheduler-v2.git + ``` + +2. Create a topic branch for your changes: + + ```bash + git checkout -b fix-for-that-thing + ``` +3. Commit a failing test for the bug: + + ```bash + git commit -am "Adds a failing test to demonstrate that thing" + ``` + +4. Commit a fix that makes the test pass: + + ```bash + git commit -am "Adds a fix for that thing!" + ``` + +6. If everything looks good, push to your fork: + + ```bash + git push origin fix-for-that-thing + ``` + +7. [Submit a pull request.](https://github.com/swat-sccs/scheduler-v2/pulls) + + +## Adding new features + +Thinking of adding a new feature? Awesome! [open an issue](https://github.com/swat-sccs/scheduler-v2/issues). and let’s work on it together!