Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 2.88 KB

contributing.md

File metadata and controls

50 lines (34 loc) · 2.88 KB
Raw

This is the contributing.md of our project. Great to have you here. Here are a few ways you can help make this project better!

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.

Guidelines

  • Before starting to work on any issue or feature, open an issue explaining the changes you want to make and wait for any of the project maintainers to assign it to you.

  • Once the issue has been assigned, we'd recommend you creating a new branch with name issue-xx where xx is the issue number that you were assigned to.

  • Before commiting any changes, make sure you format the code. (You can use formatters like Prettier)

  • Use better commit messages that explain the changes you make. View the example below:

    • Bad commit message: updated readme
    • Good commit message: updated contributors list in readme

  • You should not, in any case, use resources or code snippets from sources that do not allow their public use.

Pull Requests Review Criteria

  • Please fill the PR Template properly while making a Pull Request.
  • Your work must be original, written by you not copied from other resources.
  • You must comment on your code or script where necessary.
  • Follow the proper style guides for your work.
  • For any queries or discussions, please feel free to drop a message.

Other points to remember while submitting your work:

We want your work to be readable by others; therefore, we encourage you to note the following:

  • Please avoid creating new directories if at all possible. Try to fit your work into the existing directory structure you have created for your project. If you want to, please contact before doing so.
  • The files should be concise and clear about what the script is about and what it does.
  • It should be documented briefly enough to let readers understand.
  • If you have modified/added code work, make sure that code works before submitting.
  • If you have modified/added documentation work, ensure your language is concise and contains no grammar errors.
  • Do not update the README.md and Contributing_Guidelines.md.

Team members

You can view all of our team members on github here

Get in touch

There are various communication channels through which you can get in touch with us: