Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.32 KB

contributing.md

File metadata and controls

28 lines (18 loc) · 1.32 KB
Raw

Contributing to Omni Network

Thank you for considering contributing to the Omni Network! We appreciate contributions of all forms, from code to documentation. Here's how you can help:

Branching Model

We use Trunk Based Development for managing branches, please refer to the Branching Model for more details.

How to Contribute

Testing

  • Unit Testing: Isolate tests to specific code paths or failure modes within functions. Ensure each function's failure modes and code paths are thoroughly tested.
  • Integration Testing: Focus on testing sophisticated interactions between components.

Issues

  • Use the search tool to avoid duplicate issues.
  • Provide detailed reports including source code and commit SHA for bugs.
  • Engage with existing issues by providing feedback or reactions.

Pull Requests

  • Open PRs against the main branch only.
  • Include tests for new or modified code.
  • Follow the Go guidelines shown in the Go Code Review Comments and this Solidity Style Guide.
  • Ensure all exported types outside of the internal package are well-documented.
  • Run linters and tests locally before submitting your PR, install the pre-commit hooks by running make install-pre-commit.