sulfurx5 / gitgrind Goto Github PK

Contributing to GitGrind:CP Edition

Welcome to GitGrind:CP Edition! We're thrilled to have you contribute to our project.

To contribute to GitGrind:CP Edition, please follow these steps:

1. Fork the Repository:

   • Click on the "Fork" button at the top right corner of this repository's page. This will create a copy of the repository in your GitHub account.

2. Clone the Forked Repository:

   git clone https://github.com/YourUsername/GitGrind.git
   

   Clone the forked repository to your local machine using the above command. Replace YourUsername with your GitHub username.

3. Wait for Issue Assignment:

   • Issues will be assigned to contributors in chronological order.
   • Please wait for your issue to be assigned before starting to work on it.

4. Create a New Branch:

   git checkout -b YourRollNumber
   

   Create a new branch for your contribution using the above command. Replace YourRollNumber with your actual roll number.

5. Make Changes and Commit:

   • Make your changes in the codebase.
   • Stage your changes: git add .
   • Commit your changes with a descriptive message:

     git commit -m "Fix bugs in question X"
     

     Replace the commit message with a clear and concise description of the changes you made.

6. Push Changes to Your Branch:

   git push --set-upstream origin YourRollNumber
   

   Push your changes to the branch you created on your forked repository. Replace YourRollNumber with your actual roll number.

7. Create a Pull Request:

   • Go to the original repository on GitHub.
   • Click on the "New Pull Request" button.
   • Select your branch (YourRollNumber) in the base repository and create the pull request.

Contributors can choose any one of the 20 CP questions to solve. Issues will be assigned to contributors in chronological order. Wait for your issue to be assigned before starting to work on it.

"There are four types of CP questions:

1. Provide a Solution for the Question
2. Fix Bugs in the Code
3. Optimize the Solution
4. Provide a Different Approach

Points will be assigned based on the type of questions you have solved."

Issues will be initially assigned for 12 hours. If a contributor does not submit a pull request within this timeframe, the issue will be reassigned.

If you have any doubts or need clarifications, please ask in the Discord of GDSC IIITL: GDSC IIITL Discord Server.

• Commit all your changes related to different questions in the same branch named with your roll number.
• Commit your changes frequently and use descriptive commit messages.
• Test your changes thoroughly before submitting a pull request.
• Unassigned pull requests will not be considered.

You can find additional issues in the GitGrind:CP Edition here: issues

We hope this guide has provided you with the information needed to contribute effectively to GitGrind:CP Edition. Your contributions are invaluable, and we look forward to your pull requests! Happy coding! 🚀