Skip to content

CoderMonkiey/my-first-oss

Repository files navigation

My First OS Contribution ✨

This is a simple project to get started with Open Source contribution 🚀.

Slide Deck

Prerequisites

  1. You must have a Github Account
  2. A machine with Git set up

Steps

  1. Fork this repository

  2. Clone the forked repository into your local

    git clone "url"
  3. Checkout a new branch

    git checkout -b pr/<your_github_user_id>

    stick to the branch naming convention of pr/<your_github_user_id>

  4. Open the project in your preferred code editor/IDE

  5. Add your github-id to the Contributors.md file

    - [<Github-user-name>](https://github.com/<Github-user-name>/)
  6. Stage your changes

    git add .
  7. Commit your changes

    git commit -m '<MESSAGE_HERE>'
  8. Push your changes

    git push -u origin pr/<your_github_user_id>
  9. Raise a PR against https://github.com/CoderMonkiey/my-first-oss main branch

  10. ✨ now you are open source contributor, let the admin accept your PR 🚀