Skip to content

Latest commit

 

History

History
73 lines (36 loc) · 3.57 KB

CONTRIBUTING.md

File metadata and controls

73 lines (36 loc) · 3.57 KB
Raw

Welcome to contributing guide

Thank you for investing your time in contributing to the project! Any contribution you make will be reflected on respective repo.

Before you contribute

Read our Code of Conduct to keep your contribution approachable and respectable in the community.


Types of contributions accepted

  • 📣 Discussions - Discussing the project, its goals and have conversations.

  • 🐞 Issues - Report an issue or suggest a feature.

  • 🌏 Translations - Translations for the project if required.

  • 🛠️ Pull Request [PR] - is a way to suggest changes in our repository to make small changes such as a typo, sentence fix, or a broken link, or more specific to do code contribution to Add Feature, Fix issues, Fix Bugs etc.. in the project.


New contributor guide

Read opensource.guide to learn how to contribute to any Open-Source project. To get an overview of the project, read the README.md file in the repo or repo wiki.

Getting started

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.


🐞 Issues

Create a new issue

before you create a new issue, search if issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. See Labels for more information. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.


🛠️ Make Changes

When you're finished with the changes, create a pull request, also known as a PR. Before you contribute by PR please make sure

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.

  • Don't forget to link PR to issue if you are solving one.

  • As you update your PR and apply changes, mark each conversation as resolved. This will help us to understand how your PR is progressing.

  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.

  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

  • check for typos or spelling mistakes in the changes before you commit

  • format document before submission to ensure it is readable and easy to review

Your PR is merged!

Congratulations 🎉🎉 your PR is merged ✨.

Once your PR is merged, your contributions will be publicly visible on the repo.