Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 1.95 KB

Contributing to harmor

Thank you for your interest in contributing to harmor! Every contribution, whether it's a small bug fix or a new feature, helps make this project better. This document provides some guidelines to ensure smooth collaboration.

Setting Up Your Development Environment

  1. Fork the harmor repository to your own GitHub account.

  2. Clone your fork to your local machine:

    git clone https://github.com/YOUR_USERNAME/harmor.git

  3. Navigate to the project directory:

    cd harmor

Reporting Bugs

  • Check if the bug has already been reported in the issues section.
  • If the issue doesn't already exist, create a new issue.
  • Provide a clear and descriptive title.
  • Describe the steps to reproduce the bug.
  • Include any relevant code snippets or error messages.

Suggesting Enhancements

  • Check the issues section to see if the enhancement has already been suggested.
  • If it hasn't, create a new issue.
  • Provide a clear and descriptive title.
  • Describe your enhancement in detail.

Pull Requests

  1. Create a new branch for your feature or bugfix:

    git checkout -b feature/your-feature-name

  2. Make your changes.

  3. Push your branch to your fork:

    git push origin feature/your-feature-name

  4. Create a pull request from your branch to the harmor main branch.

  5. Describe your changes in the pull request.

  6. Ensure your code has no conflicts with the base branch.

Coding Standards

  • Write clean, readable, and maintainable code.
  • Follow the coding style used throughout the project.
  • Include comments to explain your code when necessary.

Final Notes

Your contributions will undergo a review process. This is not a critique of you, but a necessary step to ensure the quality of the code and the consistency of the project.

Thank you for taking the time to contribute!