Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.87 KB

contributing.md

File metadata and controls

35 lines (23 loc) · 1.87 KB
Raw

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to this repository and its packages, which are hosted by 022ey on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Contributing

So, you decided to contribute an algorithm or some set of codes that is written in Python, here is a guideline to open your pull request and get it merged at early. Here is a list of guidelines to read before you submit your contribution (Because we don't want your hardwork to wait before it can be showed off to people).

Important Guidelines

How Can I Contribute?

There are ways you can contribute to this repo,

  1. By opening a new issue if you are facing something in a code.
  2. By adding your own set of algorithms and python based files and opening a Pull Request.

For an instance let's believe you are opening an issue.

Here are some guidelines on those.

  • If you see an old issue you are still facing, attach the issue number along with the new issue and description on how to reproduce this.

Moving ahead with PRs

The guidelines for your PRs to be submitted are easy and simple

  • Add a folder and name it something cool for example if you are adding an algorithm to check person's age using OpenCV 2.0 name your folder as Age Checker Via OpenCV
  • Add a readme file stating how it works and the prerequisites (if any) and a Requirement.txt if your script uses some 3rd Party packages.
  • Add your script to that folder
  • Open a PR with the name of your folder (as here the PR would be called Age Checker Via OpenCV and add a two line description on what it does.
  • That's it the maintainers will review your code, ask for changes (if any) and if everything is in order, merge it.

Happy Contributing