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.
-
Fork the Repository
- Create your own fork of the repo. This allows you to work freely without affecting the main project.
-
Create a Branch
- Create a branch in your forked repo for your contribution. Preferably, use a clear and descriptive name.
-
Make Your Changes
- Implement your changes, adhering to our coding standards and guidelines.
- If you're adding functionality, please include tests.
-
Commit Your Changes
- Write clear, concise commit messages. This helps us understand and review your contribution.
-
Push to the Branch
- Push your changes to your branch in your forked repository.
-
Submit a Pull Request
- Open a pull request against our main branch.
- Include a clear description of the changes and any relevant issue numbers.
-
Code Review
- Wait for a core team member to review your pull request. Be open to feedback and revisions if necessary.
- Ensure your code passes all tests. We use Hardhat for automated testing.
- Add new tests for any new features or bug fixes.
- If you find a bug, please open an issue in our repository.
- Provide a detailed description of the bug and steps to reproduce it.
- Update the documentation if your changes require it.
- We value clear, understandable documentation for all aspects of our project.
- Remember that contributions are subject to the project’s license, typically found in the LICENSE file.
Thank you for contributing to Clave!