Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 1.79 KB
Raw

Contributing

Thanks for being willing to contribute!

Project setup

Prequisite

The project uses pnpm as a package dependency. This is just an alternative for yarn / npm with certain benefits. Here is how to set it up https://pnpm.js.org/en/installation

Environment

  1. Fork and clone the repo
  2. Run pnpm run setup to install dependencies
  3. Create a branch for your PR with git checkout -b pr/your-branch-name

Tip: Keep your master branch pointing at the original repository and make pull requests from branches on your fork. To do this, run:

git remote add upstream https://github.com/Cogoport/cogo-toast.git
git fetch upstream
git branch --set-upstream-to=upstream/master master

This will add the original repository as a "remote" called "upstream," Then fetch the git information from that remote, then set your local master branch to use the upstream master branch whenever you run git pull. Then you can make all of your pull request branches based on this master branch. Whenever you want to update your version of master, do a regular git pull.

Add yourself as a contributor

This project follows the [all contributors][all-contributors] specification. To add yourself to the table of contributors on the README.md, please use the automated script as part of your PR:

pnpm run add-contributor

Follow the prompt and commit .all-contributorsrc and README.md in the PR. If you've already added yourself to the list and are making a new type of contribution, you can run it again and select the added contribution type.

Help needed

Please checkout the the open issues

Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks!