Contributing Guidelines

[jayantasamaddar]

The following guidelines are to be followed when contributing:

1. Fork the repository: If you want to contribute to the package, fork the repository first, and then clone it to your local machine.

2. Install the dependencies: Once you have cloned the repository, make sure to install all the dependencies required to run the package. You can do this by running the npm install (or substitute) command.

3. Create a branch: Before you start making changes, create a new branch. Name the branch in a descriptive manner that accurately describes the changes you plan to make.

4. Make your changes: Make your changes to the codebase. Ensure that your changes are consistent with the package's coding standards and conventions.

5. Write tests: After making changes, write unit tests to ensure that your changes are working as expected. Ensure that all the existing tests pass, and add new tests if necessary.

6. Commit your changes: Once you are satisfied with your changes, commit them to your local branch. Write a meaningful commit message that accurately describes the changes you made.

7. Push changes: Push the changes to your forked repository.

8. Create a pull request: Create a pull request from your branch to the main repository. Provide a detailed description of the changes you made, including any relevant screenshots, gifs or other visuals.

9. Respond to feedback: Respond to feedback from the maintainers and other contributors. If necessary, make further changes to your code and tests.

10. Get your changes merged: Once your changes have been approved, they will be merged into the main repository. Congratulations, you have contributed to the package!

Remember to be respectful and professional in all interactions with other contributors and maintainers. Thank you for your contributions!