Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

55 lines (42 loc) · 1.83 KB
Raw

Contributing Guidelines

We welcome contributions to this project! To ensure a smooth collaboration, please follow these guidelines.

How to Contribute

1. Fork the Repository

  • Click on the "Fork" button at the top right corner of this page.
  • Clone your forked repository to your local machine: 
    git clone https://github.com/your-username/repo-name.git

2. Create a Branch

  • Create a new branch for your feature or bug fix: 
    git checkout -b your-branch-name

3. Make Your Changes

  • Make the necessary changes in your local branch.
  • Ensure that your code adheres to the project's coding standards.

4. Test Your Changes

  • Run tests to confirm that your changes work as expected.
  • If applicable, add new tests for any new features.

5. Commit Your Changes

  • Commit your changes with a descriptive message: 
    git commit -m "Brief description of your changes"

6. Push to Your Fork

  • Push your changes back to your forked repository: 
    git push origin your-branch-name

7. Create a Pull Request

  • Navigate to the original repository where you want to contribute.
  • Click on the "New Pull Request" button.
  • Select your branch from the drop-down menu and create the pull request.

Code of Conduct

Please adhere to our Code of Conduct while contributing.

Issues

If you find a bug or have a feature request, please open an issue in the repository. Be sure to include relevant details and steps to reproduce the issue.

Documentation

If you are making changes to the documentation, please ensure it is clear and up-to-date.

Thank You!

Thank you for your interest in contributing to this project! Your help is greatly appreciated.