Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (44 loc) · 858 Bytes

CONTRIBUTING.md

File metadata and controls

59 lines (44 loc) · 858 Bytes

Contributing

Welcome, so you are thinking about contributing ? Awesome, this a great place to start.

Setup

git clone git@github.com:epfl-si/epfl-theme-elements.git
cd epfl-theme-elements
yarn

Test

yarn test

Build

yarn run release

and check the dist and release folders.

Release

  1. Update CHANGELOG.md
  2. Update the version in package.json and Ansible inventories.
  3. Build and commit the dist* folders
  4. Deploy and tagging (check below)
  5. Create the release package in GitHub
  6. Publish with npm publish

Deploy

# Help
./ansible/web2018sible --help

# Production
./ansible/web2018sible --prod

Tagging

git tag -a v<version> -m "EPFL Theme Elements - <version>"
git push --tags