fast/README.md

# FAST-DNA
Fast, adaptive, secure, and timeless design network architecture.

A design architecture for the web that enables real-time updating of user experiences based on changing inputs.

## Policies
### Contributions
Details including getting start can be found [here](https://github.com/Microsoft/fast-dna/blob/master/CONTRIBUTING.md).

#### Getting started
First, clone the repository and `cd` into the project.

Install [lerna](https://github.com/lerna/lerna):
```shell
npm install --global lerna
```

Bootstrap lerna to install all dependencies:
```shell
lerna bootstrap
```

### Code of conduct
Details are located [here](https://github.com/Microsoft/fast-dna/blob/master/CODE_OF_CONDUCT.md).

### Guiding principles and governance
Details around process, expectations, and quality [visit](https://fluentweb.com/prototyping/contribution-policy).

## Commit and merge messages
FAST-DNA takes inspiration from [conventional commits](https://conventionalcommits.org/) and has been modified to meet requirements.

**Accepted title format**: "`<type>(<scope>): <description>`"

Optionally, include more detail in the message with a single blank line between formatted as:
```
<body>

<footer>
```

### Types
The following types are supported:
- **build**: Changes that affect the build system or external dependencies
- **docs**: Documentation changes
- **feat**: Adding or changing a feature
- **fix**: Fixing an issue / bug
- **refactor**: Architectural changes that do not address a bug or feature
- **test**: Adding or changing test infrastructure

### Scopes
Optionally used when changes impact an area, feature, or package. 
- Use component name (e.g.: button, hyperlink)
- Use pattern name (e.g.: banner, additional-information)
- Use package name (e.g.: fast-development-site)

### Description
Describe what feature or fix the user gets from this PR.
- Use single line
- Use lowercase
- Use imperative, present tense (e.g.: fix, not fixes)
- Use single sentence without sentence casing and no period at the end

### Body
Optional `<body>` used to provide clarity and context to the description.

### Footer
Optional `<footer>` used to provide additional metadata about the pull request such as issue fixing (fix #19, close #19, resolve #19).

### Pull request commenting
Add a comment with the issue number per the [github closing issue keywords](https://help.github.com/articles/closing-issues-using-keywords/).

Example title
```
feat(button): add a border radius to button
```

Example message detail
```
Sequence indicators markup was moved from being located after the slider markup to at the top for improved accessibility because the screen reader can read all of the slide options individually before interacting with the slider.

fix #915,#920
close #213
resolve #429
```

## Contact
* Submit [for help](https://stackoverflow.com/questions/tagged/fast-dna) 
* Submit [feature requests](https://github.com/Microsoft/fast-dna/issues/new?labels=feature%20:%20request)
* Submit [feature questions](https://github.com/Microsoft/fast-dna/issues/new?labels=feature%20:%20question)
feat: adds fast-react-jss-manager project (#2) * adding contribution policy and contribution guides * clean package.json in prep for monorepo * adding getting-started documentation * adding lerna * adding linting process * adding author * adding fast-react-jss-manager * adding react-jss-manager * adding commit message details to the readme * renaming package * removing duplication of content * point package.json repository to the correct repository * updating packages 2018-03-03 03:35:22 +03:00			`# FAST-DNA`
docs: update documentation for contributions, code of conduct, and pa… (#19) * docs: update documentation for contributions, code of conduct, and packages * updated conventional changelog details per feedback from team 2018-03-08 06:03:14 +03:00			`Fast, adaptive, secure, and timeless design network architecture.`

docs: update readme with contact and description (#49) * docs: update readme with contact and description * docs: update per CR request 2018-03-13 02:25:14 +03:00			`A design architecture for the web that enables real-time updating of user experiences based on changing inputs.`

docs: update documentation for contributions, code of conduct, and pa… (#19) * docs: update documentation for contributions, code of conduct, and packages * updated conventional changelog details per feedback from team 2018-03-08 06:03:14 +03:00			`## Policies`
			`### Contributions`
			`Details including getting start can be found [here](https://github.com/Microsoft/fast-dna/blob/master/CONTRIBUTING.md).`

build: adds changelog script and documentation (#20) 2018-03-08 21:06:35 +03:00			`#### Getting started`
docs: update documentation for contributions, code of conduct, and pa… (#19) * docs: update documentation for contributions, code of conduct, and packages * updated conventional changelog details per feedback from team 2018-03-08 06:03:14 +03:00			First, clone the repository and `cd` into the project.

			`Install [lerna](https://github.com/lerna/lerna):`
			```shell
			`npm install --global lerna`
			```

			`Bootstrap lerna to install all dependencies:`
			```shell
			`lerna bootstrap`
			```

build: adds changelog script and documentation (#20) 2018-03-08 21:06:35 +03:00			`### Code of conduct`
			`Details are located [here](https://github.com/Microsoft/fast-dna/blob/master/CODE_OF_CONDUCT.md).`

			`### Guiding principles and governance`
			`Details around process, expectations, and quality [visit](https://fluentweb.com/prototyping/contribution-policy).`

docs: update documentation for contributions, code of conduct, and pa… (#19) * docs: update documentation for contributions, code of conduct, and packages * updated conventional changelog details per feedback from team 2018-03-08 06:03:14 +03:00			`## Commit and merge messages`
			`FAST-DNA takes inspiration from [conventional commits](https://conventionalcommits.org/) and has been modified to meet requirements.`

			Accepted title format: "`<type>(<scope>): <description>`"

			`Optionally, include more detail in the message with a single blank line between formatted as:`
			```
			`<body>`

			`<footer>`
			```

			`### Types`
			`The following types are supported:`
			`- build: Changes that affect the build system or external dependencies`
			`- docs: Documentation changes`
			`- feat: Adding or changing a feature`
			`- fix: Fixing an issue / bug`
			`- refactor: Architectural changes that do not address a bug or feature`
			`- test: Adding or changing test infrastructure`

			`### Scopes`
			`Optionally used when changes impact an area, feature, or package.`
			`- Use component name (e.g.: button, hyperlink)`
			`- Use pattern name (e.g.: banner, additional-information)`
			`- Use package name (e.g.: fast-development-site)`

			`### Description`
			`Describe what feature or fix the user gets from this PR.`
			`- Use single line`
			`- Use lowercase`
			`- Use imperative, present tense (e.g.: fix, not fixes)`
			`- Use single sentence without sentence casing and no period at the end`

			`### Body`
			Optional `<body>` used to provide clarity and context to the description.

			`### Footer`
			Optional `<footer>` used to provide additional metadata about the pull request such as issue fixing (fix #19, close #19, resolve #19).

			`### Pull request commenting`
			`Add a comment with the issue number per the [github closing issue keywords](https://help.github.com/articles/closing-issues-using-keywords/).`

			`Example title`
			```
			`feat(button): add a border radius to button`
			```

			`Example message detail`
			```
			`Sequence indicators markup was moved from being located after the slider markup to at the top for improved accessibility because the screen reader can read all of the slide options individually before interacting with the slider.`

build: adds changelog script and documentation (#20) 2018-03-08 21:06:35 +03:00			`fix #915,#920`
			`close #213`
			`resolve #429`
docs: update readme with contact and description (#49) * docs: update readme with contact and description * docs: update per CR request 2018-03-13 02:25:14 +03:00			```

			`## Contact`
			`* Submit [for help](https://stackoverflow.com/questions/tagged/fast-dna)`
			`* Submit [feature requests](https://github.com/Microsoft/fast-dna/issues/new?labels=feature%20:%20request)`
			`* Submit [feature questions](https://github.com/Microsoft/fast-dna/issues/new?labels=feature%20:%20question)`