The website for the CSIS Commission on Strengthening America's Health Security. It is built on the CSIS Jekyll Starter that utilizes gulp, Sass, Autoprefixer, PostCSS, Webpack, imagemin, and Browsersync to speed-up development.
$ git clone https://github.com/CSIS-iLab/health-commission.git
$ cd health-commission
$ npm install
$ bundle install --path vendor/bundle
$ npm startThis will give you file watching, browser synchronisation, auto-rebuild, CSS injecting, etc.
$ npm startThis will set the JEKYLL_ENV to production and use the production config file(s) set in frasco.config.js to override default settings.
$ npm run buildThis will display all available commands, such as running eslint or imagemin independently.
$ npm runYou can also use any of the default Jekyll commands listed in their docs.
For more information on what is included and modifying the default configuration, see the What's Included guide.
When modifying the code base, always make a new branch. Unless it's necessary to do otherwise, all branches should be created off of master.
Branches should use the following naming conventions:
| Branch type | Name | Example |
|---|---|---|
| New Feature | feature/<short description of feature> |
feature/header-navigation |
| Bug Fixes | bug/<short description of bug> |
bug/mobile-navigation |
| Documentation | docs/<short description of documentation being updated> |
docs/readme |
| Code clean-up/refactoring | refactor/<short description> |
refactor/apply-linting |
| Content Updates | content/<short description of content> |
content/add-new-posts |
When ready to merge, submit a Pull Request into master. All code will be reviewed by the lead developer on the project before being merged into master.
Write clear and concise commit messages describing the changes you are making and why. If there are any issues associated with the commit, include the issue # in the commit title.
- This project uses the BEM naming convention.
Copyright © 2018 CSIS iDeas Lab under the MIT License.