CONTRIBUTING.md

Contributing to tslint-folders-diagrams

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/tslint-folders-diagrams
    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).

dependencies

We use semantic-release to manage versioning and the build process.

npm install -g semantic-release-cli

We use yarn because we like it, and to avoid an issue with commitizen on Windows.

use a feature branch

Any pushes to master will try to publish to npm (if travis build succeeds). So it's best to first develop on a feature branch - named like feature/my-feature, and then when it has a green build, merge it to master.

This project uses semantic release, so when committing its best to use this script:

./commit.sh

running unit tests

locally: (minimal build)

yarn build-and-test

before pushing: (saves time waiting for a failed build)

yarn test:prod

merging to master (will create a release!)

merging a feature branch into master: (after the build is green!)

via github site (recommended)

• create pull request for the feature branch
• merge the pull request into master

via command line (not recommended, as then need to delete branches)

git checkout master
git fetch && git pull
git merge feature/my-feature
git push

releasing (from master branch)

To release, simply push to github. This will automatically run builds, generate release notes on github, and release to npm!

git push