Thank you for considering contributing to the Flask-Auth project! We're welcome your contributions to improve the project and make it better our project. This document outlines the guidelines for contributing to the project. Please read it carefully before making any contributions.
Please note that this project follows the Contributor Covenant Code of Conduct. We expect all contributors to adhere to this code of conduct in all interactions related to the project.
We're welcome various forms of contributions:
- Including bug reports
- Feature suggestions
- Code improvements
- Documentation updates
If you encounter any bugs while using the this project, please check the existing issues to see if it has already been reported. If not, you can create a new issue with detailed steps to reproduce the bug and any relevant information about your environment.
If you have an idea to enhance the project, please create a new enhancement request issue. Describe your suggestion and its benefits clearly, and provide any related examples or use cases.
Before submitting any changes, please ensure the following:
- Check the existing issues and pull requests to see if your contribution is already being addressed.
- Fork the repository and create a new branch for your changes.
- Make your changes following the coding guidelines.
- Write clear and concise commit messages that describe your changes.
- Test your changes thoroughly.
Once your changes are ready, submit a pull request. We'll review your contribution, provide feedback if necessary, and merge it into the project if everything looks good.
To set up the project for development on your local machine, follow the steps in the README file. It provides instructions for installing dependencies and running the project.
To maintain consistency and readability, please follow the coding guidelines described in the CONTRIBUTING file.
We value code quality and encourage the addition of tests with any code changes. Ensure that your changes are well-tested and do not break existing functionality.
Documentation is essential to help users understand the project and its usage. If you make changes that impact user functionality or introduce new features, please update the project's documentation accordingly.
By contributing to the Flask User Authentication, you agree that your contributions will be licensed under the MIT License.