- Contributing to codefolio is fairly easy. This document shows you how to get started
- Fork the repo
- Check out a new branch based and name it to what you intend to do:
- Example:
If you get an error, you may need to fetch branch first by using
$ git checkout -b BRANCH_NAME
$ git remote update && git fetch
- Use one branch per fix / feature
- Example:
- Commit your changes
- Please provide a git message that explains what you've done
- Please make sure your commits follow the conventions
- Commit to the forked repository
- Example:
$ git commit -am 'describe your changes'
- Push to the branch
- Example:
$ git push origin BRANCH_NAME
- Example:
- Make a pull request
- Make sure you send the PR to the
main
branch - Make sure to
npm run lint
before making PR - Make sure the build checks have passed after generating PR
- If build checks fail, see what went wrong in workflow.
- Make sure you send the PR to the
If you follow these instructions, your PR will land pretty safely in the main repo!