forked from microsoft/fast
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update documentation for contributions, code of conduct, and pa… (
microsoft#19) * docs: update documentation for contributions, code of conduct, and packages * updated conventional changelog details per feedback from team
- Loading branch information
1 parent
44dc167
commit 33c327f
Showing
10 changed files
with
362 additions
and
915 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,7 @@ | ||
### Commit/Merge messages | ||
Commit messages should be in the following format: | ||
> `type(category): [description] [issue number].` | ||
## Detail | ||
|
||
Must be one of the following **types**: | ||
- `a11y` | ||
- `chore` | ||
- `docs` | ||
- `feat` | ||
- `fix` | ||
- `other` | ||
- `refactor` | ||
- `style` | ||
- `test` | ||
|
||
**Category:** This should be an area or feature name. For example, c-button. | ||
## Attributes | ||
|
||
**Description:** A single line, lowercase, ending with a '.', and without naming any component this relates to. Components can be referred to by the *Tag(s)*. | ||
|
||
**Issue number:** Maps directly to the GitHub issue number. Can be more than one if the work is related. | ||
|
||
**Labels:** Specific changes mapping to how work is managed across the project. | ||
|
||
Example: | ||
>`docs(readme): add an accessibility section to the readme [123456]` | ||
For [details on formatting](https://fluentweb.com/prototyping/contribution-policy) the title, details, and attributes. |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,60 +1,6 @@ | ||
# Contributing | ||
This project welcomes contributions and suggestions. Most contributions require you to agree to a | ||
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
the rights to use your contribution. For details, visit https://cla.microsoft.com. | ||
# Contribution policy | ||
A “Contribution” is any work that is voluntarily submitted to a project. This work may be code, documentation, design, answering questions, or even triaging issues. | ||
|
||
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide | ||
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions | ||
provided by the bot. You will only need to do this once across all repos using our CLA. | ||
Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com. | ||
|
||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. | ||
|
||
## 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 | ||
``` | ||
|
||
## Commit message format | ||
FAST-design follows [conventional commits](https://conventionalcommits.org/) for commit messages. Additional types are heavily inspired by Angular's [commit message format](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit). | ||
|
||
Per conventional commits 1.0.0, a commit message should be structured as follows: | ||
``` | ||
<type>[optional scope]: <description> | ||
[optional body] | ||
[optional footer] | ||
``` | ||
|
||
### Types | ||
The following types are supported: | ||
- **build**: Changes that affect the build system | ||
- **docs**: Documentation only changes | ||
- **feat**: Adding a new feature | ||
- **fix**: Fixing an issue / bug | ||
- **perf**: Performance related changes | ||
- **refactor**: Refactoring existing features | ||
- **test**: Changes specific to tests | ||
|
||
### Description | ||
Commit message descriptions should be concise and must conform to the following: | ||
- use the imperative, present tense. (fix - not fixes) | ||
- single sentence without sentence casing (fix - not Fix) | ||
- no period at the end | ||
|
||
### Body | ||
The body is optional. It should be used to provide clarity and context to the description. | ||
|
||
### Footer | ||
The footer should provide additional metadata about the pull request such as issue fixing (fixes #19). | ||
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,82 @@ | ||
# FAST-DNA | ||
Fast, adaptive, secure, and timeless design network architecture. | ||
|
||
## Policies | ||
### Contributions | ||
Details including getting start can be found [here](https://github.com/Microsoft/fast-dna/blob/master/CONTRIBUTING.md). | ||
|
||
### 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). | ||
|
||
## 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 | ||
``` | ||
|
||
## 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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.