Skip to content

Latest commit

 

History

History
83 lines (50 loc) · 4.45 KB

CONTRIBUTING.md

File metadata and controls

83 lines (50 loc) · 4.45 KB
Raw

How to contribute

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on our release history.

Read our Code of Conduct to keep our community approachable and respectable.

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

Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

What you can contribute in this repo?

  • You found a new bug, and you want to fix it

  • You want to fix an existing issue

  • You've some feature suggestions (new feature, UI/UX enhancement, etc.), and you want to contribute

  • You're looking for an open-source project to

    • Contribute your energy
    • Learn and practice programming skills
    • etc.

If you found a bug, and you want to fix it

  1. If you spot a problem with the FeatBit, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.
  2. Join our Slack and tell us that you want to fix the issue you create.
  3. We will assign the issue to you so that no one else will work on it simultaneously. We will provide you with maximum support.

But of course, you can fix the issue without telling us.

If you want to fix an existing issue

  1. Scan through our existing issues to find one that interests you.
  2. Join our Slack and tell us which issue you want to fix.
  3. We will assign the issue to you so that no one else will work on it simultaneously. We will provide you with maximum support.

But of course, you can fix the issue without telling us.

If you have some feature suggestions, and you want to contribute

  1. Create a new thread in Discussion with the detail of your suggestion.
  2. Join our Slack and tell us you want to contribute to the thread you created.
  3. We will discuss this with you and schedule the tasks for the feature suggestions. We will provide you with maximum support.

But of course, you can finish your contribution and create a PR without notifying us in advance.

If you're looking for an open-source project to contribute

  1. Join our Slack. We will provide you the contribution task list that you can contribute.
  2. Scan through the task list to find one that interests you.
  3. Start your contribution. We will provide you with maximum support.

Commit your update and PR your contribution to main project

  • Step 1 - Fork this repository.
  • Step 2 - Clone the repository to your local machine.
  • Step 3 - Add the changes to your repository.
  • Step 4 - Create a PULL Request from forked project to FeatBit. We may ask for changes to be made before a PR can be merge.
  • Step 5 - Congratulations 🎉🎉 Your PR is approved and Merged !!!
  • Step 6 - FeatBit team thanks you. You becomes one of the contributor of FeatBit 🎉🎉 .

If the steps above isn't very clear, you can search "GitHub Forks and Pull Requests" on Youtube.

LET'S CONTRIBUTE !!!