Skip to content

Latest commit

 

History

History
87 lines (56 loc) · 4.06 KB

CONTRIBUTING.md

File metadata and controls

87 lines (56 loc) · 4.06 KB
Raw

Contributing to Unruggable Gateways

We welcome contributions from the community to help extend and improve the EVM Gateway codebase. Whether you want to report a bug, suggest a feature, or contribute code, your help is greatly appreciated. The premise behind the development of this software is to minimise duplication of effort and provide tooling that allows developers to interface with a simple, standardised API to read data from other chains.

Getting Started

To get started with contributing, please follow these steps:

  1. Fork the Repository: Fork the repository to your own GitHub account.

  2. Clone Your Fork: Clone your forked repository to your local machine.

    git clone https://github.com/your-username/unruggable-gateways.git
cd unruggable-gateways

  3. Create a New Branch: Create a new branch for your work. Make sure to give it a descriptive name that summarizes your changes.

    git checkout -b feature/your-feature-name
    git checkout -b bug/fix-broken-thing

  4. Install Dependencies: Install the necessary dependencies.

    foundryup
forge install
bun i

  5. Make Your Changes: Make your changes to the codebase. Ensure your changes are well-documented and follow the existing code style.

  6. Run Tests: We utilize Github Actions to run our tests on each push (see v2.yml). Ensure all tests pass before submitting your changes. You can run tests with the following command:

    bun test

  7. Commit Your Changes: Commit your changes with a clear and concise commit message. Follow the Conventional Commits style for commit messages.

    git add .
git commit -m "feat: add feature description"

  8. Push to Your Fork: Push your changes to your forked repository.

    git push origin feature/your-feature-name
    git push origin bug/fix-broken-thing

  9. Create a Pull Request: Open a pull request (PR) to the main branch of the original repository. In the PR description, provide a detailed explanation of your changes, including any related issues.

Code of Conduct

Please note that this project has a Code of Conduct to ensure a welcoming and respectful environment for everyone. By participating, you are expected to uphold this code.

Contribution Guidelines

To maintain consistency and quality in the codebase, please adhere to the following guidelines:

  • Code Style: Follow the existing code style and structure. Ensure your code is clean, readable, and well-documented.
  • Testing: All new features and bug fixes should be covered by tests. Make sure that your tests pass before submitting your pull request.
  • Documentation: If your contribution adds or changes functionality, please write appropriate documentation and submit a matching pull request to our documentation reopsitory.
  • Keep It Focused: Make sure your pull request is focused on a single issue or feature. Avoid combining multiple unrelated changes in a single PR.

Reporting Issues

If you encounter a bug, have a feature request, or need help, please open an issue on the GitHub Issues page. When opening an issue, please provide as much detail as possible to help us understand the problem or suggestion.

Community

Join the discussion and stay up to date with the community on our Discord server or follow us on Twitter.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you for your interest in contributing to Unruggable Gateways! Together, we can build a robust and efficient solution for the blockchain ecosystem.