Thank you for investing your time in contributing to our project!
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting an issue
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
To get started, read our Code of Conduct.
Our process started from creating Issues. After the issues assigned to you, you can then start working on it and create a pull request
. We actively welcome your pull requests and invite you to submit pull requests directly here, and after review, these can be merged into the project.
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
- Finding ways to contribute to open source on GitHub
- Set up Git
- GitHub flow
- Collaborating with pull requests
If you spot a problem with the the project/repo, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels
as filters. See Labels for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
- Refer README to know how to run the project locally.
- Create a branch locally with these branch names:
- fixes:
fix/...
- features:
feature/...
- docs:
docs/...
- fixes:
When you're finished with the changes, create a pull request, also known as a PR to the dev
branch and assign me (amirfakhrullah) as a reviewer.
Once reviewed, we will merged your pr.