Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (39 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 2.14 KB

Important Guidelines

Thank you for investing your time in contributing to our project! Any contribution you make will be greatly appreciated. In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Before you start contributing

  1. Make sure you have a GitHub account.
  2. Submit an issue for your feature or bug fix in the main project repo and tag either @Naganathan05 or @Hariprasath8064. Do check if the issue already exists or not before creating a new one to avoid duplicates.
  3. Wait for the issue to be assigned to you after which you can start working on it.
  4. Follow the best practices and guidelines mentioned below.

How to contribute to this project

To contribute to this project, please follow the below guidelines:

  1. Make sure you're assigned the issue you're working on before you start working on it.

  2. Fork the project. Use the main branch as your base for your fork.

  3. Clone the forked project to your local machine.

    git clone <your_forked_repo_clone_url>

  4. Create a branch in your forked repo with a relevant name.

    git checkout -b <branch_name>

  5. Make the necessary changes and commit those changes.

    git add .
git commit -m "your_commit_message"

  6. Push changes to your forked repo.

    git push origin <branch_name>

  7. Once you push the changes to your repo, the Contribute Button will appear in Github.

  8. Click that button and you will be taken to the PR page. Describe what changes you have made and submit the PR.

  1. Mention the issue link in the PR description.
  2. If the PR is still a work in progress, start the title with "[WIP]".
  3. If the PR is complete, start the title with "[COMPLETED]".
  4. Add "@Naganathan05" or "@Hariprasath8064" as reviewers.
9. Wait for the PR to be reviewed by the maintainers. 10. Make the required changes if the maintainers ask for them. 11. Once the maintainers approve the PR, the PR will be merged.