-
Notifications
You must be signed in to change notification settings - Fork 601
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
1 parent
0727f7e
commit e70acfd
Showing
26 changed files
with
8,542 additions
and
14 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 |
---|---|---|
@@ -0,0 +1,3 @@ | ||
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 [[email protected]](mailto:[email protected]) with any additional questions or comments. |
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 |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# 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. | ||
|
||
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 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 [[email protected]](mailto:[email protected]) 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). |
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,14 +1 @@ | ||
|
||
# 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. | ||
|
||
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 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 [[email protected]](mailto:[email protected]) with any additional questions or comments. | ||
# FAST-DNA |
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 |
---|---|---|
@@ -0,0 +1,7 @@ | ||
{ | ||
"lerna": "2.9.0", | ||
"packages": [ | ||
"packages/*" | ||
], | ||
"version": "independent" | ||
} |
Oops, something went wrong.