CSIS Technology Policy Program Data Governance Table

Quick-start Instructions

$ git clone https://github.com/CSIS-iLab/tech-policy-database.git
$ cd tech-policy-database
$ npm install
$ npm start

Version

Note that this project uses React v16.9 and should not be updated until the React Scroll Sync plugin has been updated to use new lifecycle hooks.

Usage

Local Development

This will give you file watching, browser synchronization, auto-rebuild, CSS injecting, etc.

$ npm start

Build for Production

$ npm run build

See More Commands

This will display all available commands, such as running eslint or imagemin independently.

$ npm run

Branching

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.

Commit Messages

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.

CSS Styles

• This project uses the BEM naming convention.

Copyright / License

Copyright © 2019 CSIS iDeas Lab under the MIT License.