contributing.md

Contribution Guidelines

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

• To improve the documentation: Submit a pull request
• For a bug report: Open an issue
• For a feature request: Open an issue

Pull Requests

Please ensure your pull request adheres to the following guidelines:

• Search previous PRs before making a new one, as yours may be a duplicate.
• Make an individual pull request for each suggestion.

Report issues using GitHub's issues

Report a bug/feature by opening a new issue; it's that easy!

Bug Report

Great Bug Report tend to have:

• A quick summary and/or background
• Steps to reproduce
  • Be specific
  • Share the snapshot (if possible)
• What actually happens
• What you expected would happen
• Notes (possibly including why you think this might be happening)

Feature Request

Great Feature Requests tend to have:

• A quick idea summary
• What & why you wanted to add the specific feature
• Additional context like images, links to resources to implement the feature, etc

Thank you for your contributions!