Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation for Code of Conduct and Contribution Guideline #9

Merged
merged 6 commits into from
Sep 23, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
create CONTRIBUTING.md
Signed-off-by: onur-ozkan <work@onurozkan.dev>
onur-ozkan committed Sep 23, 2024
commit 54e01747cde8f2918a8888ad1f8251d2f9b22f2a
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.