Contributing to clarity-seed
The clarity-seed project team welcomes contributions from the community. Follow the guidelines to contribute to the seed.
Before you start working with Clarity, please complete the following steps:
- Read our code of conduct.
- Read our Developer Certificate of Origin. 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.
Here are the typical steps in a contributor's workflow:
- Fork the main Clarity seed 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.
- 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.
# Clone your forked repository git clone email@example.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 firstname.lastname@example.org # 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 # 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 master branch, use the following to update:
git checkout my-new-feature git fetch -a git pull --rebase upstream master git push --force-with-lease origin my-new-feature
Updating Pull Requests
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 amend the commit.
git add . git commit --amend git push --force-with-lease origin my-new-feature
If you need to squash changes into an earlier commit, use the following:
git add . git commit --fixup <commit> git rebase -i --autosquash master git push --force-with-lease origin my-new-feature
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
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@example.com>
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 repository. You must provide:
- 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