From 249642567fbabfacc33750e1f6bc9772a4f8d23f Mon Sep 17 00:00:00 2001 From: Spore02 Date: Wed, 4 Dec 2024 11:15:26 +0100 Subject: [PATCH] Create contribution.md According the issue Contributing file #38 I propose to integrate a file named "contribution.md". --- contribution.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 contribution.md diff --git a/contribution.md b/contribution.md new file mode 100644 index 0000000..b522a90 --- /dev/null +++ b/contribution.md @@ -0,0 +1,39 @@ +# How to contribute +First, thanks for taking the time to contribute to our project! There are many ways you can help out. + +### Questions + +If you have a question that needs an answer, create an issue and label it as a question. + +### Issues for bugs or feature requests + +If you encounter any bugs in the code, or want to request a new feature or enhancement, please create an issue to report it. Kindly add a label to indicate what type of issue it is. + +### Contribute Code +We welcome your pull requests for bug fixes. To implement something new, please create an issue first so we can discuss it together. + +***Creating a Pull Request*** + +Please create a git commit. In addition: + +- Make sure your code respects existing formatting conventions. In general, follow the same coding style as the code that you are modifying. +- Do add/update documentation appropriately for the change you are making. +- Bugfixes should include a unit test or integration test reproducing the issue. +- Do not use author tags/information in the code. +- Try to keep pull requests short and submit separate ones for unrelated features, but feel free to combine simple bugfixes/tests into one pull request. +- Keep the number of commits small and combine commits for related changes. + Each commit should compile on its own and ideally pass tests. +- Keep formatting changes in separate commits to make code reviews easier and + distinguish them from actual code changes. + +When your code is ready to be submitted, submit a pull request to begin the code review process. + +We only seek to accept code that you are authorized to contribute to the project. + +With a pull request you accept our terms and conditions: +> I confirm that this contribution is made under the terms of the license found in the root directory of this repository's source tree and that I have the authority necessary to make this contribution on behalf of its copyright owner. + +## Code of Conduct + +We encourage inclusive and professional interactions on our project. We welcome everyone to open an issue, improve the documentation, report bug or submit a pull request. By participating in this project, you agree to abide by the BMW Code of Conduct. +