We welcome contributions from the community. Here are some guidelines to help you get started.
- Make sure you have a GitHub account.
- Submit a ticket for your issue, assuming one does not already exist.
- Clearly describe the issue, including steps to reproduce when it is a bug.
- Make sure you fill in the earliest version that you know has the issue.
- Fork the repository on GitHub.
- Make the changes in your fork.
- Follow the coding conventions of the project.
- If you are adding new functionality, make sure to write tests.
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the repository.
- Update your GitHub issue to mark that you have submitted code and are ready for it to be reviewed (Status: Ready for Merge).
- Include a link to the pull request in the ticket.
- The core team looks at Pull Requests on a regular basis.
- After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.
- Document any external behavior in the README.md.
- Document any internal behavior in the code.
- We are using pytest for testing our application. Please make sure all of your changes are covered by an appropriate set of automated tests.
- We are using flake8 for style guide enforcement. Please make sure your code adheres to the style guide.
- We appreciate your contributions to the project. If you are an individual contributor, your name will be added to the CONTRIBUTORS.md file in recognition of your work.
- For more information on the core team and contributors, please check out the CONTRIBUTORS.md file.
- If you have any questions or need further clarification, please open an issue.
Thank you for considering contributing to KeyGuardian. We look forward to your contributions.