Skip to content

Commit

Permalink
Add contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
talyssonoc committed Oct 4, 2021
1 parent f8f2f41 commit 4e22b8b
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 4e22b8b

Please sign in to comment.