Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1.72 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.72 KB
Raw

Participiant: How to Contribute

  1. Check for Open Issues: Look for any open issues in the repository. If you find one that interests you, ask to be assigned to it by commenting on the issue. You can also add your own issues or bugs you encountered

    Please do not work on an issue if you are not assigned to it

  2. Setup Your Codebase:

    • Fork the repository to your GitHub account and copy it's clone URL
    • Clone your forked repository to your local machine using Git (make sure it's installed)

    For this repo:

    git clone [email protected]:acmpesuecc/SaveMe.git

  3. Make Your Changes

    • Make a separate branch like your-username or name for example before making changes

    (Warning: your changes would not be considered if they are directly made on main/master branch)

    • After cloning and setting up your branch, make the necessary changes to the code in your IDE.

    • Feel free to ask your doubts in the comments or reach out to the repo owner

  4. Commit and Push: Commit your changes and push them to your fork:

    git commit -m "Describe the changes you made"
git push

    Alternatively, use VSCode's inbuilt Git source control pane Ctrl+Shift+G if you're uncomfortable with a CLI

  5. Submit a Pull Request: After pushing your changes, open a pull request to pull changes from your fork to the original repository.

  6. Get Feedback Wait for a maintainer to review your pull request (PR) and provide feedback.

  7. Gain Bounty Points If everything is approved, your issue will be closed, and you'll gain bounty points on the leaderboard!