Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 3.29 KB

Contributing

Contributions are welcome and will be fully credited. Please read and understand the contribution guide before creating an issue or pull request. Contributions are accepted via Pull Requests on Github.

Etiquette

This project is open source, and as such, the maintainers give their free time to build and maintain the source code held within. They make the code freely available in the hope that it will be of use to other developers. It would be extremely unfair for them to suffer abuse or anger for their hard work.

Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the world that developers are civilized and selfless people.

It's the duty of the maintainer to ensure that all submissions to the project are of sufficient quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.

Viability

When requesting or submitting new features, first consider whether it might be useful to others. Open source projects are used by many developers, who may have entirely different needs from your own. Think about whether or not your feature is likely to be used by other users of the project.

Issues

Issue reports are warmly welcomed, as we know it's important aspect of open source software. Whether it's a bug or a possible enhancement, We are aware that it will improve and build trust among the community. Before filing an issue, please consider the following things.

  • You can add an issue in the issues section
  • Make sure the same issue is not reported by any other person.
  • Add a decent title and sufficient description of the issue, you may also add some screenshots.
  • Please consider adding label to issue that allows us to understand nature of the issue.
  • Please consider adding fixes via pull requests if you are aware of the root cause of the issue and a possible solution.
  • For enhancement, please provide the necessity of the feature, the problem it solves and what it offers as an improvement in the library.
  • Please consider adding a response if the answer added on the discussion solves the issue.

Pull Requests

  • Add tests! - Your patch won't be accepted if it doesn't have tests.

  • Document any change in behaviour - Make sure the readme.md and any other relevant documentation are kept up-to-date.

  • Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.

  • Descriptive Branch Name - Please add descriptive branch name that aligns with the implementation

  • One pull request per feature - If you want to do more than one thing, send multiple pull requests.

  • Which Branch - All bug fixes and new features should always be sent to the master branch, which contains the upcoming release.

  • Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Happy coding!