Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 2.61 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to the Covalent EWM light-client project (and its associated smart contracts on base)! We welcome contributions from the community to help improve the security, functionality, and usability of our contracts.

Getting Started

  1. Fork the repository and clone your fork locally.
  2. Install the necessary dependencies by running npm install or yarn install.
  3. Familiarize yourself with the project structure and the existing smart contracts using the readme.

Development Process

  1. Create a new branch for your feature or bug fix: git checkout -b feature/your-feature-name or git checkout -b fix/your-bug-fix.
  2. Write clean, readable, and well-documented code following the project's coding conventions.
  3. Test your changes thoroughly to ensure they work as expected and do not introduce any new issues.
  4. Use npm run coverage to test changes for backward compatibility. Look in the ./test directory for all unit and integrations tests.
  5. Add tests for the new feature.
  6. Commit your changes with a descriptive commit message: git commit -m "Add feature X" or "Fix bug Y".
  7. Push your changes to your forked repository: git push origin feature/your-feature-name.
  8. Open a pull request against the main repository's develop branch, providing a clear description of your changes and any relevant information.

Pull Request Guidelines

  • Ensure that your code adheres to the project's coding style and conventions.
  • Write clear, concise, and meaningful commit messages.
  • Include tests for your changes to maintain code coverage.
  • Document any new features, changes, or updates in the code and README file.
  • Be responsive to feedback and be willing to make changes to your pull request if requested.

Security

Please see our SECURITY.md document for information about reporting security vulnerabilities, our bug bounty program, and our responsible disclosure policy.

Code of Conduct

We expect all contributors to follow our Code-of-Conduct to ensure a welcoming and inclusive environment for everyone.

License

By contributing to this project, you agree that your contributions will be licensed under the [Apache 2.0] License.

Contact

If you have any questions, suggestions, or feedback, feel free to reach out to us at telegram t.me/noslav, discord or email krishnateja@covalenthq.com or twitter/X.

Thank you for your contributions and support!