Skip to content

Files

Latest commit

 

History

History
51 lines (39 loc) · 1.85 KB

CONTRIBUTING.md

File metadata and controls

51 lines (39 loc) · 1.85 KB

Contributing to [Project Name]

First off, thank you for considering contributing to our project! Your involvement is essential for keeping [Project Name] great.

How Can I Contribute?

Reporting Bugs

If you find a bug in the project, please create an issue on our GitHub Issues page and include:

  • A clear and descriptive title.
  • A detailed description of the bug.
  • Steps to reproduce the bug.
  • Expected and actual behavior.
  • Screenshots if applicable.
  • Any additional information that could help debug the issue.

Suggesting Enhancements

If you have ideas on how to improve the project, we'd love to hear from you! Create an issue on our GitHub Issues page and include:

  • A clear and descriptive title.
  • A detailed description of the enhancement.
  • Why this enhancement would be useful.
  • Examples and mockups if possible.

Submitting Pull Requests

Fork the Repository

1 Fork the repository by clicking the "Fork" button on our GitHub repo. 2 Clone your fork to your local machine: git clone https://github.com/your-username/your-repo.git

Create a Branch

Create a new branch for your work: git checkout -b feature/your-feature-name

Make Your Changes

Make your changes on your branch. Follow the project's coding style and conventions. Be sure to include tests for your changes if applicable.

Commit Your Changes

Commit your changes with a descriptive commit message: git commit -m "Add feature: description of your feature"

Push Your Changes

Push your changes to your fork: git push origin feature/your-feature-name

Open a Pull Request

  1. Go to the original repository on GitHub.
  2. Click on the "Pull Request" button.
  3. Select your branch and submit your pull request.
  4. Provide a clear and descriptive title for your pull request.
  5. Describe your changes in detail in the pull request description.