Skip to content

Commit

Permalink
create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Signed-off-by: onur-ozkan <[email protected]>
  • Loading branch information
onur-ozkan committed Sep 23, 2024
1 parent 6855b0b commit 54e0174
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## 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 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.

0 comments on commit 54e0174

Please sign in to comment.