Skip to content

Latest commit

 

History

History
17 lines (10 loc) · 936 Bytes

CONTRIBUTING.md

File metadata and controls

17 lines (10 loc) · 936 Bytes
Raw

We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. 👏

Instructions

These steps will guide you through contributing to this project:

  • Fork the repo

  • Clone it and install dependencies

      git clone https://github.com/YOUR-USERNAME/typescript-library-starter
  npm install

Keep in mind that after running npm install the git repo is reset. So a good way to cope with this is to have a copy of the folder to push the changes, and the other to try them.

Make and commit your changes. Make sure the commands npm run build and npm run test:prod are working.

Finally send a GitHub Pull Request with a clear list of what you've done (read more about pull requests). Make sure all of your commits are atomic (one feature per commit).