Config Replicator Contribute
First off, thank you for considering contributing to "Config Replicator".
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
The Config Replicator is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the tool itself.
Please note we have a code of conduct, please follow it in all your interactions with the project.
Your First Contribution
Unsure where to begin contributing to this project? You can start by looking through the issues, if any or create one.
Working on your first Pull Request? You can learn how from this *free* series, How to Contribute to an Open Source Project on GitHub.
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
- Open a Pull Request to fix/implement an Issue, or you can also fork the project and then send a pull request
- Ensure cross-platform compatibility for every change proposed. Windows, Mac, Debian & Ubuntu Linux, whenever is possible.
- Ensure that no personal info, data or passwords were left on the code to upload.
- Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
- Keep feature versions as small as possible, preferably one new feature per version.
- Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See the Python Community Code of Conduct.
- Update the README.md with details of the changes made, this includes but not limited to: new environment variables, exposed ports, useful file locations and container parameters.
- Update also the documentation in docs, we use Sphinx to generate the Docs
- Increase the version numbers in any examples files, README.md and docs files to the new version that this Pull Request would represent.
- Wait for one of the developers to merge your code. Be Patient!
How to file a bug report
When filing an issue, make sure to answer these five questions:
- What version of Python are you using?
- What operating system and processor architecture are you using?
- What did you do?
- What did you expect to see?
- What did you see instead?
How to ask for a new feature
Open an issue, and the community will get to it as quick as possible, just understand that it may take some time, the developers are not 100% dedicated to this project.
Code of Conduct
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting
Code, Commit Message and Labeling Conventions
There is no a strict convention that we use for the commit messages, just be verbose enough so everybody can understand the changes that you made.
Regarding the code we always try to follow the PEP8 Style Guide