Skip to content

Latest commit

 

History

History
31 lines (19 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

31 lines (19 loc) · 1.56 KB

Contributing Guidelines

Thank you for your interest in contributing to this project! Your contributions help improve the quality and functionality of the project. Please follow the guidelines below to ensure a smooth contribution process.

How to Contribute

  1. Fork the Repository: Start by forking the repository to your own GitHub account. This will allow you to freely make changes without affecting the main project.

  2. Clone the Repository: Clone your forked repository to your local machine using the command:

    git clone <your-fork-url>

  3. Create a New Branch: Before making any changes, create a new branch for your feature or bug fix. Use a descriptive name for the branch:

     git checkout -b my-feature-branch

  4. Make Your Changes: Implement your feature or fix the bug in this branch. Ensure that your code adheres to the project's coding standards and is well-documented.

  5. Test Your Changes: Run the project locally to verify that your changes work as expected. Add unit tests if applicable to ensure the new code is covered by tests.

  6. Commit Your Changes: Commit your changes with a descriptive commit message:

     git commit -m "Add my feature or fix the issue"

  7. Push Your Changes: Push your changes back to your forked repository:

     git push origin my-feature-branch

  8. Open a Pull Request: Go to the original repository and open a pull request (PR) from your feature branch. Provide a clear description of your changes, why they are necessary, and any other relevant information.