Skip to content
This repository has been archived by the owner on Mar 27, 2023. It is now read-only.

Commit

Permalink
Update CONTRIBUTING.md with DCO details
Browse files Browse the repository at this point in the history
Signed-off-by: Travis Finch <[email protected]>
  • Loading branch information
travisfinch authored and jeeyun committed Nov 4, 2016
1 parent 7d02a20 commit 1be1254
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,15 @@ The Clarity project team welcomes contributions from the community. Together,
Before you start working with Clarity, please complete the following steps:

- Read our [code of conduct](/CODE_OF_CONDUCT.md).
- Sign our Contributor License Agreement (CLA). Our CLA-bot will take you through the process and update the issue when you open a [Pull Request](https://help.github.com/articles/creating-a-pull-request/). For questions about the CLA process, see our [FAQ](https://cla.vmware.com/faq) or contact us through the GitHub issue tracker.
- 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

Here are the typical steps in a contributor's workflow:

- [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.
Expand All @@ -30,14 +31,18 @@ git clone [email protected]:<github username>/clarity.git
# Navigate to the directory
cd clarity

# Set name and e-mail configuration
git config user.name "John Doe"
git config user.email [email protected]

# Setup the upstream remote
git remote add upstream https://github.com/vmware/clarity.git

# Create a topic branch for your changes
git checkout -b my-new-feature master

# After making the desired changes, commit and push to your fork
git commit -a
git commit -a -s
git push origin my-new-feature
```

Expand Down Expand Up @@ -85,6 +90,8 @@ Use this format for your commit message:
<detailed commit message>
<BLANK LINE>
<reference to closing an issue>
<BLANK LINE>
Signed-off-by: Your Name <[email protected]>
```

#### Type
Expand All @@ -106,7 +113,7 @@ These documents provide guidance creating a well-crafted commit message:

## Reporting Bugs and Creating Issues

You can submit an issue or a bug to our [GitHub repositoory](https://github.com/vmware/clarity/issues). You must provide:
You can submit an issue or a bug to our [GitHub repository](https://github.com/vmware/clarity/issues). You must provide:

* The link to the reproduction scenario you created using [http://plnkr.com](http://plnkr.com)
* The version number of Angular
Expand Down

0 comments on commit 1be1254

Please sign in to comment.