Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

52 lines (33 loc) · 2.43 KB
Raw

Contribution Guidelines

First off, thank you for considering contributing to this project! It's people like you that make this utility great. Whether you're correcting a typo, adding a new feature, or improving the existing ones, you're making our project better, and we appreciate it. 🎉

Where to Start?

  • Beginner: If you're new to the project and want to give a hand, look for issues labeled good first issue. These are simple tasks that would be a good starting point.
  • Bug Fixes: If you're here to squash some bugs, look for the bug label.
  • Features: features are labeled as enhancement.

Ground Rules

Every participant is expected to follow the project's Code of Conduct. Please make sure you are welcoming and friendly in all our spaces. Ensure that you don't break any existing functionality. Always make a new branch for your changes. Ensure that your code adheres to the existing coding conventions. Write tests for your changes to ensure that they work correctly. Document your changes thoroughly.

How to Contribute?

  1. Fork & create a branch: If something you want to add/correct doesn't have an associated issue, create one. Then fork the repository and create a branch off main.

  2. Code: Make your modifications, ensuring you stick to the guidelines mentioned above.

  3. Test: Ensure that your changes don't break anything.

  4. Document: Fill in the required template for the pull request. This will include:

    • A short description of the change.
    • A list of the changes and why you've made them.
    • Any relevant screenshots or logs.
    • A link to the associated issue (if applicable).

  5. Pull Request: Submit a pull request targeting the main branch of the main repository. Provide a clear and comprehensive description of your pull request.

  6. Revise: If maintainers suggest changes, revise your pull request accordingly.

Setting up the Development Environment

  1. Fork the repository.
  2. Clone your forked repository to your machine.
  3. Run npm install to install all the dependencies.
  4. Make your changes and test them out.
  5. Submit your pull request.

Reporting a Bug

If you find a bug, please create an issue in our repository. Use the bug report template to ensure that we have all the information we need.

Suggesting Enhancements

If you have an idea to enhance the project, please create an issue. Use the feature request template to ensure clarity.