Skip to content

Latest commit

 

History

History
117 lines (93 loc) · 5.23 KB

CONTRIBUTING.md

File metadata and controls

117 lines (93 loc) · 5.23 KB

Contributor's Guide

Welcome to 30-Days-Of-CPP! 🧑🏻‍💻

We appreciate your interest in contributing. 💐 This guide will help you get started with the project and make your first contribution.

Line

🌟 Creating Your First Pull Request

  1. Star this repository.

  2. Fork this repository.

  3. Clone the forked repository:

    git clone https://github.com/<your-github-username>/30-Days-Of-CPP.git
    • If you have already forked the project, update your copy before working:
    git remote update

  4. Navigate to the project directory:

    cd 30-Days-Of-CPP

  5. Set an upstream with the parent repository and local repository:

    git remote add upstream https://github.com/subhadipbhowmik/30-Days-Of-CPP.git
    • If you have altered it, you have to rebase it:
    git rebase upstream/<branch_name>

  6. Create a new branch:

    git checkout -b <your_branch_name>

    Branch name example: feature/added-day1-content or, bug/search-not-working

  7. Make changes. Do the Necessary changes in the code or files.

  8. Stage your changes and commit:

    git add .
git commit -m "<your_commit_message>"

  9. Push your local commits to the remote repo:

    git push -u origin <your_branch_name>

  10. Create a Pull Request.

    • Go to your forked repository on GitHub.
    • Click on the "Compare & pull request" button.
    • Write a title and description for your pull request.
    • Click on the "Create pull request" button.
    • Important: Make sure to mention the issue number in the pull request description. For example, "Fixes #1".
    • Note: Do not close the issue until it is approved.

Line 11. Congratulations! 🎉 you've made your contribution.

Alternatively Contribute Using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

    • Go to the GitHub website and navigate to your fork of the repository.
    • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  8. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  9. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the repository.

Line

⚡ Important Guidelines

  1. The contributors will be allowed to work on the issue ONLY after it has been assigned to them.
  2. The contributions will be counted only for the time period of the event, after the time period ends contributions can be taken in but won't be counted for the final evaluation.
  3. Tampering or any unethical behavior to the files or other participants will result in immediate disqualification.
  4. Each PR must be associated with only ONE issue.
  5. Don't open pull requests with minor text edits on other people's repositories.
  6. Don't create multiple issue requests for one issue.

Line

Thank you for your contribution!!

Line

Tip from us 😇

It always takes time to understand and learn. So, don't worry at all. We know you have got this! 💪

Show some ❤️ by 🌟 this repository!