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

  1. Fork the repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your feature or bug fix.

Making Changes

  1. Ensure you have the latest changes from the main repository.
  2. Make your changes in your feature branch.
  3. Write or update tests as necessary.
  4. Ensure all tests pass.
  5. Commit your changes with clear and descriptive commit messages.

Submitting a Pull Request

  1. Push your changes to your fork on GitHub.
  2. Open a pull request from your feature branch to the main repository's develop branch.
  3. Provide a clear description of the changes and reference any related issues.
  4. 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!

Previous
Troubleshooting