From 4e22b8b441d9973bc8744e9f5d1eec80a31f3d3f Mon Sep 17 00:00:00 2001 From: Talysson Date: Mon, 4 Oct 2021 12:01:25 -0300 Subject: [PATCH] Add contributing.md --- contributing.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 contributing.md diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..ccc4d55 --- /dev/null +++ b/contributing.md @@ -0,0 +1,21 @@ +# Contributing + +Contributions are always welcome! When contributing to Node API boilerplate we ask you to follow our code of conduct: + +## Code of conduct + +In short: _Be nice_. Pay attention to the fact that Node API boilerplate is free software, don't be rude with the contributors or with people with questions and we'll be more than glad to help you. Destructive criticism and demanding will be ignored. + +## Opening issues + +When opening an issue be descriptive about the bug or the feature suggestion, don't simply paste the error message on the issue title or description. Also, **provide code to simulate the bug**, we need to know the exact circumstances in which the bug occurs. Again, follow our [code of conduct](#code-of-conduct). + +## Pull requests + +When opening a pull request to Node API boilerplate, follow this steps: + +1. Fork the project; +2. Create a new branch for your changes; +3. Do your changes; +4. Open the pull request; +5. Write a complete description about the bug or the feature the pull request is about.