Skip to content

Latest commit

 

History

History
55 lines (31 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

55 lines (31 loc) · 1.76 KB
Raw

Contributing to Clave

Welcome to the Clave! We're thrilled you're considering contributing to our project. Every contribution, from code to documentation, helps us create a better product and community.

How to Contribute

  1. Fork the Repository

    • Create your own fork of the repo. This allows you to work freely without affecting the main project.

  2. Create a Branch

    • Create a branch in your forked repo for your contribution. Preferably, use a clear and descriptive name.

  3. Make Your Changes

    • Implement your changes, adhering to our coding standards and guidelines.
    • If you're adding functionality, please include tests.

  4. Commit Your Changes

    • Write clear, concise commit messages. This helps us understand and review your contribution.

  5. Push to the Branch

    • Push your changes to your branch in your forked repository.

  6. Submit a Pull Request

    • Open a pull request against our main branch.
    • Include a clear description of the changes and any relevant issue numbers.

  7. Code Review

    • Wait for a core team member to review your pull request. Be open to feedback and revisions if necessary.

Testing

  • Ensure your code passes all tests. We use Hardhat for automated testing.
  • Add new tests for any new features or bug fixes.

Reporting Bugs

  • If you find a bug, please open an issue in our repository.
  • Provide a detailed description of the bug and steps to reproduce it.

Documentation

  • Update the documentation if your changes require it.
  • We value clear, understandable documentation for all aspects of our project.

Licensing

  • Remember that contributions are subject to the project’s license, typically found in the LICENSE file.

Thank you for contributing to Clave!