Contributing
How to contribute
Thank you for your interest in contributing to the Haddock App project! We welcome contributions from the community to help improve and grow this open-source project.
Getting Started
- Fork the repository on GitHub.
- Clone your forked repository to your local machine.
- Create a new branch for your feature or bug fix.
Making Changes
- Ensure you have the latest changes from the main repository.
- Make your changes in your feature branch.
- Write or update tests as necessary.
- Ensure all tests pass.
- Commit your changes with clear and descriptive commit messages.
Submitting a Pull Request
- Push your changes to your fork on GitHub.
- Open a pull request from your feature branch to the main repository's
develop
branch. - Provide a clear description of the changes and reference any related issues.
- Wait for the maintainers to review your pull request.
Code Style and Guidelines
- Follow the existing code style and conventions used in the project.
- Write clear and concise code with appropriate comments.
- Ensure your code is well-documented.
Reporting Issues
- Use the GitHub issue tracker to report bugs or suggest enhancements.
- Provide a clear and detailed description of the issue or suggestion.
- Include steps to reproduce the problem if reporting a bug.
Community Guidelines
- Be respectful and considerate of other contributors.
- Engage in constructive discussions and provide helpful feedback.
- Follow the project's code of conduct.
We appreciate your contributions to the Haddock project!