Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

69 lines (47 loc) · 2.45 KB
Raw

Contributing

This document contains a set of guidelines to help you during the contribution process.

We are happy to welcome all contributions from anyone willing to improve this project. Thank you for helping out and remember, no contribution is too small.

Step by step contribution guide

  1. Install the Requirements
  2. Fork the repository and Clone the fork to your machine
  3. Open an issue before working on your changes
  4. Create a git branch and Start working on your fix, feature, etc on its branch
  5. Create and Run the tests (if there are any)
  6. Commit your changes according to Commit Message Guidelines
  7. Push the changes to your fork and Create a Pull Request for review
  8. Communicate with the maintainer about the revisions
  9. Be responsive if someone request changes for your contributions
  10. Your contribution gets accepted. 🎉🎉🎉

NOTE: Be sure to get the latest from "upstream" before making a pull request!

Commit Message Guidelines

We have strict rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history.

Template

We use the commit message template from dotfiles. You may find any other additional types, and more information below (if there are any).

Revert and Merge

Use default GIT templates for revert and merge.

Issues

Before creating a new issue, please search for similar issues, open or closed, to see if someone else has already noticed the same problem and possible solutions.

Do not comment on open issues unless you can provide more information to resolve it. Use the subscribe function to keep up-to-date with the issue or the voting system to support it.

Bug reports

When you can't find a previous bug, open an issue keeping in mind the following considerations:

  • Try to reproduce the bug using the code found on the main branch
  • Copy and paste the full error message, including the backtrace
  • Be as detailed as possible and include any additional information

Feature requests

If you want to request or implement a new feature please submit an issue describing the details and possible use cases.

Thanks

Thank you to all who have contributed to this great project.