diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..996acfd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# Contributing to Drauth + +Thank you for your interest in contributing to the Drauth project! We welcome contributions from the community to help improve and enhance our web application. Whether you are a developer, designer, tester, or documentation enthusiast, there are many ways you can contribute. + +## Getting Started + +Before you start contributing, please make sure you have done the following: + +1. **Familiarize Yourself with the Project**: Take some time to understand how the Drauth works by reading the project documentation and browsing through the codebase. + +2. **Set Up a Development Environment**: If you haven't already, set up a development environment on your local machine with Python and Django installed. + +3. **Check for Open Issues**: Look for open issues in the [issue tracker](https://github.com/teamhashed/drauth/issues) and consider picking one to work on. If you have a new idea or find a bug not listed, please create a new issue to discuss it. + +4. **Fork the Repository**: Fork the Drauth repository to your GitHub account by clicking the "Fork" button at the top right of the project page. + +5. **Clone Your Fork**: Clone your fork of the repository to your local machine using `git clone`. + +6. **Create a New Branch**: Create a new branch for your contribution using a descriptive name, e.g., `feature/add-analytics`. + +7. **Install Dependencies**: Install project dependencies by running `pip install -r requirements.txt`. + +## Making Contributions + +Now that you're set up, you can start making contributions: + +1. **Code**: Write code that addresses the issue you're working on. Follow the project's coding style and guidelines. + +2. **Testing**: Ensure that your code is well-tested. Write unit tests and integration tests as needed. + +3. **Documentation**: Update the documentation if your changes affect it. Good documentation is crucial for the project's usability. + +4. **Commit Changes**: Commit your changes with clear and concise commit messages. Use the present tense (e.g., "Add feature" instead of "Added feature"). + +5. **Push Changes**: Push your changes to your forked repository on GitHub. + +6. **Create a Pull Request (PR)**: Open a pull request to the main repository. Include a clear description of your changes, why they are needed, and reference any related issues. + +7. **Review and Discussion**: Participate in the discussion on your PR. Address any feedback or concerns raised by maintainers and other contributors. + +8. **Merge**: Once your PR is approved, it will be merged into the main branch. Congratulations, you've made a contribution! + +## Code of Conduct + +Please note that we have a [Code of Conduct](CODE_OF_CONDUCT.md) in place. We expect all contributors to follow it when participating in this project. + +## Get Help + +If you need help or have questions about contributing, please reach out to us through the [issue tracker](https://github.com/teamhashed/drauth/issues). + +Thank you for helping make Drauth better! We appreciate your contributions. + +Happy coding!