Skip to content

contributing.md

Latest commit

 

History

History
103 lines (66 loc) · 2.1 KB

contributing.md

File metadata and controls

103 lines (66 loc) · 2.1 KB

Contributing Guidelines

Thank you for your interest in contributing to this project!
We welcome beginners and experienced developers alike. Here's a step-by-step guide to help you get started.

1. Fork the Repository

Forking means creating your own copy of the project on GitHub.

  • Click the "Fork" button on the top-right corner of this repository.
  • This creates a copy under your GitHub account.

2. Clone Your Fork Locally

  • Cloning brings the code from GitHub to your local computer.

  • Open your terminal or Git Bash and run:

git clone https://github.com/your-username/project-name.git

  • Replace: your-username with your GitHub username project-name with the name of the repository

  • Now, go into the project folder:

cd project-name

3. Create a New Branch

  • Never work directly on the main branch. Create a new branch for your changes:
git checkout -b feature-name
  • Replace feature-name with a name related to the change you're making.

4. Make Your Changes

  • Open the project in your code editor, make your changes, and save the files.

5. Stage and Commit Your Changes

  • In your terminal, run:
git add .
  • Then commit your changes with a meaningful message(For example):
git commit -m "Added CONTRIBUTING.md with detailed contribution steps"

6. Push Your Changes to GitHub

  • Send your changes to your GitHub forked repository:
git push origin feature-name

7. Open a Pull Request (PR)

  • Go to your forked repository on GitHub.

  • You’ll see a “Compare & pull request” button. Click it.

  • Fill in the title and description:

    • Mention the issue you’re fixing.

    • Describe what you changed and why.

    • Add screenshots if it’s a UI change.

  • Click “Create Pull Request”.

9. Wait for Review

  • Admin will review your PR.

  • Make the PR only after the issue is assigned.

  • They may suggest changes — you can make them in the same branch and push again in ##"base" branch.

  • Once approved, your PR will be merged!

Happy contributing! 🚀