Skip to content

Contributing.md

Latest commit

 

History

History
71 lines (46 loc) · 1.4 KB

Contributing.md

File metadata and controls

71 lines (46 loc) · 1.4 KB

How to Contribute

  1. Raise an Issue First

    • Go to the Issues tab in the repository
    • Click New Issue
    • Clearly describe your mini project, bug fix, or improvement

  2. Fork the Repository

    • Click Fork at the top-right of the repo

  3. Clone Your Fork

    git clone https://github.com/your-username/Addminiproject.git

`

  1. Create a Branch for Your Issue

    git checkout -b issue-123-description

    (Replace 123 with your issue number and a short description)

  2. Add Your Mini Project or Changes

    • Follow the project structure
    • Keep code clean and organized

  3. Commit Your Changes

    git commit -m "Add: description of your mini project or fix"

  4. Push Your Branch

    git push origin issue-123-description

  5. Open a Pull Request

    • Go to the main repository
    • Click Compare & Pull Request
    • Link your PR to the issue you created

Contribution Guidelines

  • Maintain the project structure
  • Write clear commit messages
  • Make sure your project works correctly
  • Add screenshots if your project affects the UI
  • Keep your code clean and readable

Reporting Issues

When reporting a bug or suggesting a mini project, include:

  • Clear description
  • Steps to reproduce (if applicable)
  • Expected vs actual behavior
  • Screenshots (if applicable)