Skip to content

Latest commit

 

History

History
71 lines (42 loc) · 2.41 KB

CONTRIBUTING.MD

File metadata and controls

71 lines (42 loc) · 2.41 KB

Welcome contributors 🙌

✅Following are the steps/rules for Contributing in the project -

  1. Fork the repository on GitHub.

  2. Clone the project (forked copy of the project) to your machine :

    git clone url-of-forked-project

  3. Navigate to the directory of project :

    cd screenx

  4. Set the upstream with original repository :

    git remote add upstream https://github.com/amaan-ahmad/screenx

  5. In order to check associated URLs with the project :

    git remote -v

  6. Before commiting any changes, always Pull the upstream so that the recents changes in the original repo gets merged (gets updated with recent changes)

    git pull upstream master

  7. Create a New Branch (where you need to push the changes done) and switch to the respective branch :

    git branch your_branch_name

    git checkout -b your_branch_name

  8. Add and Commit your changes with relevant message :

    git add file_name

  • While commiting, ensure that you follow the below guidelines :

    • Structure of commit message : git commit -m "{{ commit heading }}" -m "{{ commit desc }}"

    • Commit Headings

      • ⚒️[Fix]: used when we do a css-fix, ui-improvement
      • 📚[Docs]: used when modifying/updating docs
      • ♻️[Refactor]: used when refacting variables, functions, classes
      • 🐛 [Bug]: used when commits related to bug fixed/resolve in process
      • 🚀[Feat]: used when adding a new feature in application
      • 🔏 [API]: when working with API's

    • When commits are in parts Eg:

      • 🌘 [1/3] Auth: setup firebase configs
      • 🌗 [2/3] Auth: setup auth routes
      • 🌕 [3/3] Auth: finishing with auth functionalities

    • Commit Body

      • In this we can add a brief description of the modification we did in the code. So overall it would look like - git commit -m "🔐[API]: Handle CORS policy" -m "Desc: added Cors libraries to access backend from the react, added whitelist 🔥"

  1. Push the changes to the same working branch (do not push on origin master!)

    git push -u origin your_branch_name

  2. To create a Pull request ,click on compare and pull requests.

  3. Add appropriate Title and Description explaining the work you have done.

  4. And Done!! 🥳 Wait till your PR gets merged after successful submission! 😄

Happy Coding 🎯! Keep Contributing ! 🚀