First of all, thank you for considering to contribute to our software! We appreciate your time and effort. This document provides a set of guidelines to help ensure a smooth contribution process. Please take a moment to review and follow these guidelines to help maintain a healthy and inclusive project environment.
By participating in this project, you agree to abide by the Code of Conduct. Please ensure you read and follow its principles to help maintain a welcoming and inclusive community environment.
If you encounter a bug, please create a new issue in the project's issue tracker. Be sure to include the following information:
- A clear and concise description of the bug.
- Steps to reproduce the issue.
- Any additional information that may be helpful (e.g., screenshots, logs, or environment details).
To suggest a new feature or enhancement, please create a new issue in the project's issue tracker. In your suggestion, include:
- A clear and concise description of the enhancement.
- The motivation behind the suggestion (e.g., how it would improve the project or solve a problem).
- Any relevant examples or resources that support your suggestion.
At Erbsland DEV, we maintain high standards for security, reliability, and quality in our software. To ensure the integrity of the codebase, we do not accept pull requests by default. If you would like to contribute code, please follow the steps below:
-
Start by reporting a bug or suggesting a feature through the issue tracker. Alternatively, you can contact us directly to discuss your proposed contribution.
-
Wait for feedback from the maintainers or the community. This will help ensure that your proposed changes align with the project's goals and quality standards.
-
Once your proposal has been reviewed and approved, you may proceed with creating a pull request. Make sure to follow the instructions outlined in the Pull Requests section.
Please note that any pull requests submitted without prior communication or approval may be declined. This policy helps maintain the quality and consistency of the Erbsland DEV project. Your understanding and cooperation are greatly appreciated.
Once your proposal has been reviewed and approved, please follow these steps to contribute code changes:
- Create a new branch for your changes.
- Compile and test your changes.
- Write unit tests that test your added code through fully.
- Commit the changes to your new branch.
- Push your changes to your fork on GitHub.
- Open a pull request on the original repository and the repository with the unit tests.
Please note: Make sure your code follows the exact coding style of the existing code. Code that is not formatted as existing code of the project is a reason to reject your pull request.
This project uses "Black" for code formatting.
If you contribute code, you must run the "Black" code formatter with the parameter --line-length=120.
Please also follow these general coding style guidelines:
- Document all classes, methods and instance variables using doc-strings.
- Document internal and private methods if its use is not obvious.
When writing commit messages, follow these guidelines:
- Write concise and descriptive commit messages.
- Start the commit message with a capital letter.
- List every change of your commit, group the changes where possible.
- If you do extensive changes, split them into multiple small commits.
All contributions must be made under the same license as the project.
By contributing to this project, you agree to license your contributions under the same terms as the existing copyright and license. Your contributions will be incorporated into the existing copyrighted material without separate copyright attribution. This does not affect your rights to use your own contributions for any other purpose, including licensing them under different terms.