diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d7b153f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# Contributing + +## Issues + +Issues are very valuable to this project. + +* Ideas are a valuable source of contributions others can make. +* Problems show where this project is lacking. +* With a question you show where contributors can improve the user experience. + +Thank you for creating them. + +## Pull Requests + +Pull requests are a great way to get your ideas into this repository. + +When reviewing a pull request, we look at the following things: + +### Does it state intent? + +You should state which problem you are solving with your contribution. + +For example: + +> Add link to code of conduct in README.md + +This doesn't explain why the change is being made. + +> Add link to code of conduct in README.md because users don't always look in the CONTRIBUTING.md + +This tells us the problem that you have found, and the pull request shows me the action you have taken to solve it. + +### Is it of good quality? + +* There are no spelling mistakes +* It reads well +* Has a good score on [Grammarly](grammarly.com) or [Hemingway App](http://www.hemingwayapp.com/) + +### Does it move this repository closer to the overall vision for the repository? + +The aim of this repository is to: + +* Provide a list of soundtracks that boost productivity and focus +* Provide content that is usable by someone who hasn't written something like this before +* Foster a culture of respect and gratitude in the open source community + +### Does it follow the contributor covenant? + +This repository has a [code of conduct](CODE_OF_CONDUCT.md), This repository has a code of conduct, I will remove things that do not respect it.