Read the following guidelines which will help us make the contribution process easy and effective for everyone involved.
We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our Code of Conduct.
Contributions are made to this repository via Issues and Pull Requests (PRs). A few general guidelines for contributing that cover both:
- Search for existing Issues and PRs before creating your own. This will help both contributor & maintainer to make out things proper & effective.
Issues should be used to :
- Report problems with the library
- Request for a new feature
- To discuss potential changes before a PR is created
Take a look at the existing Issues or create a new issue!
Create a Pull Request (PR), which will be promptly reviewed and given suggestions for improvements by the community.
- Add screenshots or screen captures to your Pull Request to help us understand the effects of the changes proposed in your PR.
- Fork the repository to your own Github account.
- Clone the project to your machine.
- Create a branch locally under
master
with a succinct but descriptive name. - Commit changes to that branch.
- Following any formatting and testing guidelines specific to this repo.
- Push all committed changes to your fork.
- Open a PR in our repository and follow the PR template so that we can efficiently review the changes.