Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 2.83 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 2.83 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to our project.Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. The project includes labels like bug/documentation enhancement/bug/duplicate/help wanted/invalid/question/wontfix/good first issue, PR Accepted, PR Decline, waiting, modification. Then filter out issues according to the labels.

Reporting Bugs

We welcome you to use the GitHub issue tracker to report bugs.

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include information like:

  • Meaningful heading
  • Explain the bug
  • Use proper labels

Working on issues

  • First find issues you want to work on, from the issue tracker
  • Just comment on the issue if you are interested to work on and ask any related doubts on that issue section
  • Maintainer will assign the issue accordingly based on the size of issue.

Contributing via Pull Requests

Contributions via pull requests are much appreciated. First as mentioned check the issue tracker find the issue you want to work on else Report Bugs in the issue section.

To send us a pull request, please:

  1. Fork the repository. GitHub provides additional document on forking a repository
  2. Modify the source; please focus on the specific change you are contributing. Follow [Mardown Guide](https://www.markdownguide.org/basic-syntax/).
  3. Commit to your fork using clear commit messages.
  4. Send us a pull request
  5. Mention Reviewer

What should include in Commit message

  • Meaningful heading max of 50 characters
  • Description max of 72 character as word or as points or check list
  • Describe commit type like Fix, Update, docs etc...
  • Add #issue number

Pull Request Process

If you send us a pull request the reviewer will put your PR through the following phase

  • Waiting: in this phase reviewer will be checking your PR request and your PR is given a waiting label
  • If PR is accepted a review will be given to you telling your PR is accepted and assigned PR Accepted label
  • If PR is reviewed and needed modification it will be assigned with modification label with detailed review of modification.
  • If PR is giving issues related to merging the PR will be rejected and given PR Decline label with review of PR rejection reasons.

Hope you all get the idea for contributing to this project. Have a nice contributing experience.