Contributors Guidelines

General points to keep in mind

1. While contributing it is important to keep few guidelines in mind. This saves both contributors as well as reviewer time on feedback that is in general to good coding practice.
   We recommend our contributors to go through this guide once this really helps to avoid making some common mistakes.
2. Make sure to turn off any formatter that you might have enabled locally in your IDE. These fromatting changes also show up in git and make it a lot harder for reviewer to figure out the actual code changes.
3. While making a PR try to categorize your it in one of these broad categories and it as a subject of PR.
   ex:- if the PR is related to some feature than your PR subject should look like feat:<Concise_description_of_it>

• Feature
• Bug Fix
• Documentation
• Code Refactoring
• Testing
• Dependency Update
• UI/UX Enhancement
• Performance Optimization
• Security
• Localization/Internationalization (i18n)
• Cleanup/Code Style
• Other

How to create a Pull Request (PR).

• Fork the Repository: Click the "Fork" button on the top right corner of the repository's page to create a copy of the repository in your GitHub account.

• Clone Your Fork: In your terminal, clone your forked repository to your local machine. Replace [YOUR_USERNAME] with your GitHub username:
  git clone https://github.com/[YOUR_USERNAME]/[REPO_NAME].git

• Create a Branch: Create a new branch for your contribution. Use a descriptive name for your branch to indicate the nature of your changes:
  git checkout -b feature/add-new-feature

• Make Changes: Make your desired changes or improvements to the codebase. Ensure that your code follows our coding standards and guidelines.

• Commit Changes: Commit your changes with a clear and concise commit message:
  git commit -m "Add new feature: Description of your changes"

• Push Changes: Push your committed changes to your forked repository:
  git push origin feature/add-new-feature

• Create a Pull Request: Go to the original repository on GitHub and click the "New Pull Request" button. Compare and review your changes in the pull request.

• Describe Your Changes: Provide a clear and detailed description of your changes in the pull request. Explain why these changes are necessary.

• Review and Discussion: Be prepared to engage in a discussion about your pull request. Address any feedback or concerns raised by the maintainers and community.