Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
131 lines (87 loc) · 3.52 KB

CONTRIBUTING.md

File metadata and controls

131 lines (87 loc) · 3.52 KB

Contributing to SweetCode

🎉 Thank you for showing interest in contributing to SweetCode!
This project is part of GirlScript Summer of Code (GSSoC).
We welcome contributions from everyone – beginners, experts, and open-source enthusiasts alike!

🚀 Getting Started

1. Fork the Repository

Click on the Fork button at the top-right of this repo to create a personal copy of the repository under your GitHub account.

🔄 Syncing the Fork

Before making a Pull Request, always ensure your fork is up to date with the original repository. This helps prevent merge conflicts and keeps your changes aligned with the latest code.

You can easily sync your fork using GitHub’s web interface:

  1. Go to your forked repository on GitHub.
  2. On the top right, just beside the green Code button, you'll find:
    • A Contribute button (with a branching icon)
    • A Sync fork button (with a circular arrow icon)
  3. Click on Sync fork → Update branch
    to pull the latest changes from the main repository into your fork.

2. Clone the Repository

Use the following command to clone your forked repo:

git clone https://github.com/<your-username>/SweetCode.git

Replace <your-username> with your actual GitHub username.

3. Navigate to the Project Directory

cd SweetCode

4. Create a New Branch

It's good practice to create a new branch for your changes. Prfereably name the branch on the feature that you are working on:

git checkout -b <branch-name>

Example:

git checkout -b fixed-Groq-API-issue

5. Make Your Changes

Now make the necessary changes or additions in your code editor.

6. Stage and Commit Your Changes

git pull
git add .
git commit -m "Descriptive message about your changes"

7. Push Changes to Your Fork

git push origin <branch-name>

8. Create a Pull Request (PR)

  1. Go to your forked repository on GitHub.
  2. Click the Compare & pull request button.
  3. Add a title and description to your PR.
  4. Click Create pull request.

🧾 Contribution Guidelines

  • Check the Issues tab for tasks marked with the gssoc25 label.
  • You can also open new issues if you find bugs or want to suggest enhancements.
  • Admins will assign a level to each issue.

💡 Issue Levels and Points

Level Description Points
1 Beginner Tasks 4
2 Intermediate Features 7
3 Advanced Enhancements 10

Points are awarded for each merged PR based on the level assigned to the issue.

✅ Do's

  • Write clean, readable, and well-documented code.
  • Follow the existing code style and folder structure.
  • Add comments and docstrings wherever necessary.
  • Include screenshots or video demos for UI-related changes.
  • Be respectful and supportive in all interactions.

❌ Don'ts

  • Don't submit irrelevant or spammy PRs.
  • Don't make changes directly to the main branch.
  • Don't copy code without proper attribution.
  • Don't engage in inappropriate or disrespectful behavior.

📞 Need Help?

If you have any questions or need assistance, feel free to:

  • Open an issue in the repository
  • Contact the maintainers:
    • Project Admin: Tanmay Shingavi tanmayshingavi1@gmail.com
    • Mentor: Anshi Agrawal

Thank you for contributing to SweetCode! 🍭