Skip to content

Latest commit

 

History

History
28 lines (17 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

28 lines (17 loc) · 1.46 KB
Raw

CONTRIBUTING

When contributing to this repository, please first discuss the change you wish to make via issue, whatsapp, email, or any other method with the owners of this repository before making a change.

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

Where do I contribute?

  1. You can check the issues section of the repository to find all the current open issues.
  2. Find an issue which interests you, and ask the maintainer to assign it to you.
  3. You can create a new issue for a feature request or ask the maintainers to approve of any new modification.

How do I contribute?

  1. Always create a new branch and make your changes in that branch before sending a PR.
  2. Send a PR to the master branch.
  3. Ensure any install or build dependencies are added/removed before pushing new changes.
  4. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports or useful file locations.
  5. Request the maintainers to merge your branch and it's changes to the master branch after it's reviewed.

Reference Material

You can check the discussions in this notion doc

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub