Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 3.83 KB

CONTRIBUTING.md

File metadata and controls

88 lines (62 loc) · 3.83 KB
Raw

Contributing

You can make the necessary changes to the codebase and submit a pull request.
The changes can be made in any of the following ways:

- Add new features to the project.
- Add new functionality to the project.
- Fix bugs in the project.
- Make the project more user-friendly and responsive.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Some Quick Tips

  • IF you have any doubts regarding "How to merge your first PR" , checkout this video:

Merge your first PR

  • Star the repo for quicker access to it & if you like the initiative.

  • After your PR is merged, your name will appear under the "Contributors" section in README file.

Pull Request Process

  1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.

  2. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.

  3. You may merge the Pull Request in once you have the sign-off of the maintainer, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

  4. Also, make sure to do Fetch upstream to get the latest changes and resolve any impending merge conflicts.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behavior that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4