From 33c327fc076d9172f86356387ca08951dcff6777 Mon Sep 17 00:00:00 2001 From: Aaron Wentzel <16669785+awentzel@users.noreply.github.com> Date: Wed, 7 Mar 2018 19:03:14 -0800 Subject: [PATCH] =?UTF-8?q?docs:=20update=20documentation=20for=20contribu?= =?UTF-8?q?tions,=20code=20of=20conduct,=20and=20pa=E2=80=A6=20(#19)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: update documentation for contributions, code of conduct, and packages * updated conventional changelog details per feedback from team --- .github/pull_request_template.md | 24 +- CHANGELOG.md | 0 CONTRIBUTING.md | 62 +- README.md | 81 ++ package.json | 15 +- packages/fast-development-site/package.json | 16 +- .../fast-react-components-base/package.json | 19 +- .../fast-react-components-fluent/package.json | 15 +- .../fast-react-jss-manager/package-lock.json | 1021 ++++------------- packages/fast-react-jss-manager/package.json | 24 +- 10 files changed, 362 insertions(+), 915 deletions(-) create mode 100644 CHANGELOG.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 79568d23278..102773ad9ef 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -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. \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 870823527ad..b040a090d8c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: -``` -[optional scope]: - -[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. \ No newline at end of file diff --git a/README.md b/README.md index b80b63e3c86..1f9947d9d33 100644 --- a/README.md +++ b/README.md @@ -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**: "`(): `" + +Optionally, include more detail in the message with a single blank line between formatted as: +``` + + +