From b7efb417708df0ee96833a9b75ff974390020eaf Mon Sep 17 00:00:00 2001 From: Gabriel Barberini Date: Sat, 23 Sep 2023 20:03:28 -0300 Subject: [PATCH] Create CONTRIBUTING --- CONTRIBUTING | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 CONTRIBUTING diff --git a/CONTRIBUTING b/CONTRIBUTING new file mode 100644 index 0000000..bd983ed --- /dev/null +++ b/CONTRIBUTING @@ -0,0 +1,44 @@ +[![Contributors](https://img.shields.io/github/contributors/RocketPy-Team/infinity-api)](https://github.com/RocketPy-Team/infinity-api/graphs/contributors) +[![Chat on Discord](https://img.shields.io/discord/765037887016140840?logo=discord)](https://discord.gg/b6xYnNh) + +## How to contribute to Infinity-API + +#### **Did you find a bug?** + +* Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/RocketPy-Team/infinity-api/issues?q=is%3Aissue). + +* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/RocketPy-Team/infinity-api/issues). Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring. + +* If possible, use the relevant bug report templates to create the issue. + +#### **Do you want to suggest a new feature?** + +* Ensure the feature was not already requested by searching on GitHub under [Issues](https://github.com/RocketPy-Team/infinity-api/issues?q=is%3Aissue+label%3Aenhancement). + +* If you're unable to find an open issue about this feature request, you were the first one to think about it! In this case, [open a new issue](https://github.com/RocketPy-Team/infinity-api/issues). Be sure to include a title and clear description, as much relevant information as possible, including examples and bibliography if needed. + +* If possible, use the relevant bug report templates to create the issue. + +#### **Did you write a patch that fixes a bug or adds a new feature?** + +* Open a new GitHub pull request (PR) with the patch. + +* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable. + +* Before submitting, please read the [Development Guide](https://docs.rocketpy.org/en/latest/development/index.html) to know more about coding conventions. + +#### **Do you have questions about the source code or general feedback?** + +* Ask any question about Infinity-API in our [Discord Server](https://discord.gg/b6xYnNh). + +#### **Do you want to contribute to the RocketPy/Infinity-API documentation?** + +* If you are interested in improving documentation or creating tutorials, please contact us by creating an issue or sending a message in our [Discord Server](https://discord.gg/b6xYnNh). + +RocketPy/Infinity-API is a volunteer effort. We encourage you to pitch in and join [the team](https://github.com/RocketPy-Team/infinity-api/contributors)! + +Welcome to our community! :rocket: :rocket: :rocket: + +**RocketPy Team** + +*This guide was inspired by the [Ruby on Rails](https://github.com/rails/rails/blob/main/CONTRIBUTING.md) project.*