Permalink
Browse files

Initial commit

  • Loading branch information...
jeeyun committed Nov 7, 2016
1 parent 0a4f150 commit 3b800665eae7f0613789b03214dabeaada41f6a8
Showing with 158 additions and 45 deletions.
  1. +8 −0 .gitignore
  2. +19 −0 CODE_OF_CONDUCT.md
  3. +60 −29 CONTRIBUTING.md
  4. +71 −16 README.md
  5. BIN logo.png
View
@@ -0,0 +1,8 @@
coverage/
dist/
html-report/
node_modules/
**/*npm-debug.log.*
**/*yarn-error.log.*
.idea/
.DS_Store
View
@@ -0,0 +1,19 @@
Contributor Code of Conduct
======================
As contributors and maintainers of the Clarity project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities.
Communication through any of Clarity's channels (GitHub, mailing lists, Twitter, and so on) must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
We promise to extend courtesy and respect to everyone involved in this project, regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the Clarity project to do the same.
If any member of the community violates this code of conduct, the maintainers of the Clarity project may take action, including removing issues, comments, and PRs or blocking accounts, as deemed appropriate.
If you are subjected to or witness unacceptable behavior, or have any other concerns, please communicate with us.
If you have suggestions to improve this Code of Conduct, please submit an issue or PR.
**Attribution**
This Code of Conduct is adapted from the Angular project, version 0.3a-angular, available at this page: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md
View
@@ -2,36 +2,56 @@
# Contributing to clarity-seed
The clarity-seed project team welcomes contributions from the community. If you wish to contribute code and you have not
signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any
questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq).
The clarity-seed project team welcomes contributions from the community. Follow the guidelines to contribute to the seed.
## Community
## Contribution Guidelines
## Getting Started
Before you start working with Clarity, please complete the following steps:
- Read our [code of conduct](/CODE_OF_CONDUCT.md).
- Read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on as an open-source patch.
## Contribution Flow
This is a rough outline of what a contributor's workflow looks like:
Here are the typical steps in a contributor's workflow:
- Create a topic branch from where you want to base your work
- Make commits of logical units
- Make sure your commit messages are in the proper format (see below)
- Push your changes to a topic branch in your fork of the repository
- Submit a pull request
- [Fork](https://help.github.com/articles/fork-a-repo/) the main Clarity repository.
- Clone your fork and set the upstream remote to the main Clarity repository.
- Set your name and e-mail in the Git configuration for signing.
- Create a topic branch from where you want to base your work.
- Setup your local environment to run and build Clarity. See our [build documentation](BUILD.md).
- Make commits of logical units.
- Make sure your commit messages are in the proper format (see below).
- Push your changes to a topic branch in your fork of the repository.
- [Submit a pull request](https://help.github.com/articles/about-pull-requests/).
Example:
``` shell
# Clone your forked repository
git clone git@github.com:<github username>/clarity-seed.git
# Navigate to the directory
cd clarity-seed
# Set name and e-mail configuration
git config user.name "John Doe"
git config user.email johndoe@example.com
# Setup the upstream remote
git remote add upstream https://github.com/vmware/clarity-seed.git
# Create a topic branch for your changes
git checkout -b my-new-feature master
git commit -a
# After making the desired changes, commit and push to your fork
git commit -a -s
git push origin my-new-feature
```
### Staying In Sync With Upstream
When your branch gets out of sync with the vmware/master branch, use the following to update:
When your branch gets out of sync with the master branch, use the following to update:
``` shell
git checkout my-new-feature
@@ -40,21 +60,19 @@ git pull --rebase upstream master
git push --force-with-lease origin my-new-feature
```
### Updating pull requests
### Updating Pull Requests
If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into
existing commits.
If your PR fails to pass CI, or requires changes based on code review, you'll most likely want to squash these changes into existing commits.
If your pull request contains a single commit or your changes are related to the most recent commit, you can simply
amend the commit.
If your pull request contains a single commit, or your changes are related to the most recent commit, you can amend the commit.
``` shell
git add .
git commit --amend
git push --force-with-lease origin my-new-feature
```
If you need to squash changes into an earlier commit, you can use:
If you need to squash changes into an earlier commit, use the following:
``` shell
git add .
@@ -63,21 +81,34 @@ git rebase -i --autosquash master
git push --force-with-lease origin my-new-feature
```
Be sure to add a comment to the PR indicating your new changes are ready to review, as GitHub does not generate a
notification when you git push.
### Code Style
Make sure you add a comment to the PR indicating that your changes are ready to review. GitHub does not generate a notification when you use git push.
### Formatting Commit Messages
We follow the conventions on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/).
Use this format for your commit message:
```
<detailed commit message>
<BLANK LINE>
<reference to closing an issue>
<BLANK LINE>
Signed-off-by: Your Name <your.email@example.com>
```
#### Writing Guidelines
These documents provide guidance creating a well-crafted commit message:
Be sure to include any related GitHub issue references in the commit message. See
[GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing issues
and commits.
* [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/)
* [Closing Issues Via Commit Messages](https://help.github.com/articles/closing-issues-via-commit-messages/)
## Reporting Bugs and Creating Issues
When opening a new issue, try to roughly follow the commit message format conventions above.
You can submit an issue or a bug to our [GitHub repository](https://github.com/vmware/clarity-seed/issues). You must provide:
## Repository Structure
* Instruction on how to replicate the issue
* The version number of Angular
* The version number of Clarity
* The version number of Node
* The browser name and version number
* The OS running the seed
View
@@ -1,32 +1,87 @@
![Clarity](logo.png)
Clarity Seed
============
This is a seed project for Angular 2 applications using [Clarity](https://github.com/vmware/clarity). For more information on the Clarity Design System, visit the [Clarity website](https://vmware.github.io/clarity/).
# clarity-seed
This seed's build system is written with gulp and provides the following out of the box:
## Overview
- Angular 2 application with [clarity-icons](https://www.npmjs.com/package/clarity-icons), [clarity-ui](https://www.npmjs.com/package/clarity-ui) and [clarity-angular](https://www.npmjs.com/package/clarity-angular) included
- Development and production builds
- Unit test setup with Jasmine and Karma
- End-to-end test setup with Protractor
- Development server with browsersync
- SASS processor
- TSLint
## Try it out
Getting started
---------------
#### Installation
These are the steps to run the seed project:
```
git clone git@github.com:vmware/clarity-seed.git
cd clarity-seed
### Prerequisites
# install the project's dependencies
npm install
* Prereq 1
* Prereq 2
* Prereq 3
# starts the application in dev mode and watches your files for livereload
npm start
### Build & Run
# running unit tests
npm run test.unit
1. Step 1
2. Step 2
3. Step 3
# running e2e tests
npm run test.e2e
# dev build
npm run build.dev
# prod build
npm run build.prod
```
## Documentation
## Releases & Major Branches
For documentation on the Clarity Design System, including a list of components and example usage, see [our website](https://vmware.github.io/clarity).
#### Directory structure
```
.
├── README.md
├── gulpfile.js <- configuration of the gulp tasks
├── karma.conf.js <- configuration of the test runner
├── karma-test-shim.js <- shim for test runner
├── package.json <- dependencies of the project
├── protractor.config.js <- e2e tests configuration
├── src <- source code of the application
│   ├── app
│   │   └── components
│   │   └── app.e2e-spec.js <- sample e2e spec file
│   │   └── <component>.component.spec.ts
│   │   └── <component>.component.ts
│   │   └── <component>.html
│   │   └── <component>.scss
│   │   └── app.html
│   │   └── app.spec.ts
│   │   └── app.ts
│   │   └── main.ts <- boostrap file for the angular app
│   └── index.html
├── .editorconfig <- configuration file for IDEs
├── tsconfig.json <- configuration of the typescript project
├── tslint.json <- sample configuration file for tslint
└── typings.json
```
## Contributing
The clarity-seed project team welcomes contributions from the community. If you wish to contribute code and you have not
signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any
questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq). For more detailed information,
refer to [CONTRIBUTING.md](CONTRIBUTING.md).
The Clarity project team welcomes contributions from the community. For more detailed information, see [CONTRIBUTING.md](CONTRIBUTING.md).
## License
The clarity-seed project is licensed under the MIT license.
## Feedback
If you find a bug or want to request a new feature, please open a [GitHub issue](https://github.com/vmware/clarity-seed/issues).
View
BIN +5.4 KB logo.png
Binary file not shown.

0 comments on commit 3b80066

Please sign in to comment.