Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 3.49 KB

CONTRIBUTING.md

File metadata and controls

73 lines (48 loc) · 3.49 KB
Raw

Contributing guidelines

Pull Request Checklist

Before sending your pull requests, make sure you followed this list.

  1. Read these Guidelines in full.

  2. Please take a look at the LICENSE (it's MIT LICENSE).

  3. Check your changes are consistent with the Standards and Coding Style.

  4. Send your Pull Request to the master branch

How to become a contributor and submit your own code

Contributing code

Contributions are welcome! You can send us pull requests to Add new project or help in improving an existing project , if you are just getting started, Gitlab has a how to.

A team members will be assigned to review your pull requests. Once they reviewed your pull request and if it looks good to them, a member will approve and merge them to the repository.

If you want to contribute, Github issue are a good starting point.If you started working on a issue, leave a comment so other people know that you're working on it, you can also coordinate with others on the issue comment threads. in more specific.

  • If you see an issue already created, that you think you can resolve, comment on it and ask the maintainers to assign it to you. We will be more than glad to do so :)

  • Commit message should be of the stated syntax. Use only absolute verbs like Create, Update, etc and no past or future tenses like creating/created.

  • Add comments to codes. This increases readability. However do not raise issues or PRs only to add comments.

  • When naming the functions or variables use meaningful names instead of just random ones. Preferrably, refer to similar files or functions to get an idea.

  • Every PR would be reviewed before it gets approved to merge.

Standards and Coding Style

General guidelines

  • New project or features must include full description which help guarantee correctness in the present and future.
  • Updated projects must improve either the accoracy or the overall working of the project.
  • Project included should strictly follow python 3.X and must not include any other language.
  • For python Files, Comments must be inclued with the code for better understanding

License

Include a license at the top of new files.

MIT License

Copyright (c) 2020 Sarvesh Kumar Sharma

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Documentation

Contributors are encouraged to verify the generated documentation before each pull request.