Skip to content

Latest commit

 

History

History
63 lines (53 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

63 lines (53 loc) · 1.41 KB

Contributing

Getting Started

Make sure you perform git pull before you checkout a new branch to avoid merge conflicts!!

  1. Clone the repository

  2. Install the dependencies

    npm install
  3. Checkout to Dev branch

    git checkout Dev
  4. Create a new branch

     git checkout -b feature-name
  5. Make your changes

    Example- creating a new component

  6. Add your updated files to git to stage them for commit

    git add .
  7. Check your changes

    git status
  8. Commit your changes

     git commit -m "commit message"
    tip- use conventional commits Conventional commits are a great way to keep your commit messages organized and readable. You can read more about them here.

    Here's an example of a conventional commit:

    git commit -m "feat: footer component"

    Here's another example of a conventional commit:

    git commit -m "fix: typo in footer component"
  9. IMPORTANT⚠️ Make sure to perfrom a git pull before pushing your changes

    git pull
  10. Push your changes to GitHub

    git push
  11. Open a pull request on GitHub

  12. Wait for your pull request to be reviewed and merged!

  13. Celebrate! 🎉