Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

29 lines (19 loc) · 1.25 KB

Getting Started

  1. Fork the repository.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your contribution: git checkout -b your-branch-name

Contribution Rules

  1. There should be no linting and formatting warnings (make check can help you with that) and every test should pass.
  2. If possible, avoid adding new dependencies.
  3. Make sure to add test coverage for the new changes.
  4. Changes should be x86 and ARM compatible.

Making Contributions

  1. Push your changes to your forked repository with clear and concise commit messages that describe the purpose of your changes.
  2. Submit a pull request from your feature branch to the our main branch.
  3. Include details about the changes you've made and the problem it solves in the pull request description.
  4. Make sure none of the CI pipeline checks have failed.

Waiting for Review

  • Your pull request will typically be reviewed by the project maintainers within a week, with a maximum review time of two weeks.
  • Be prepared to address any feedback or suggestions from reviewers.

Feature Request and Bug Reports

To report bugs, suggest improvements or request new features, kindly open a GitHub issue.