Skip to content
This repository was archived by the owner on May 18, 2026. It is now read-only.

Commit ede481b

Browse files
committed
Add CONTRIBUTING template
1 parent 88f10ff commit ede481b

1 file changed

Lines changed: 76 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributing to apps-cli-plugin
2+
3+
The apps-cli-plugin project team welcomes contributions from the community. Before you start working with apps-cli-plugin, please
4+
read our [Developer Certificate of Origin](https://cla.vmware.com/dco). All contributions to this repository must be
5+
signed as described on that page. Your signature certifies that you wrote the patch or have the right to pass it on
6+
as an open-source patch.
7+
8+
## Contribution Flow
9+
10+
This is a rough outline of what a contributor's workflow looks like:
11+
12+
- Create a topic branch from where you want to base your work
13+
- Make commits of logical units
14+
- Make sure your commit messages are in the proper format (see below)
15+
- Push your changes to a topic branch in your fork of the repository
16+
- Submit a pull request
17+
18+
Example:
19+
20+
``` shell
21+
git remote add upstream https://github.com/vmware-tanzu/apps-cli-plugin.git
22+
git checkout -b my-new-feature main
23+
git commit -a
24+
git push origin my-new-feature
25+
```
26+
27+
### Staying In Sync With Upstream
28+
29+
When your branch gets out of sync with the vmware-tanzu/main branch, use the following to update:
30+
31+
``` shell
32+
git checkout my-new-feature
33+
git fetch -a
34+
git pull --rebase upstream main
35+
git push --force-with-lease origin my-new-feature
36+
```
37+
38+
### Updating pull requests
39+
40+
If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into
41+
existing commits.
42+
43+
If your pull request contains a single commit or your changes are related to the most recent commit, you can simply
44+
amend the commit.
45+
46+
``` shell
47+
git add .
48+
git commit --amend
49+
git push --force-with-lease origin my-new-feature
50+
```
51+
52+
If you need to squash changes into an earlier commit, you can use:
53+
54+
``` shell
55+
git add .
56+
git commit --fixup <commit>
57+
git rebase -i --autosquash main
58+
git push --force-with-lease origin my-new-feature
59+
```
60+
61+
Be sure to add a comment to the PR indicating your new changes are ready to review, as GitHub does not generate a
62+
notification when you git push.
63+
64+
### Code Style
65+
66+
### Formatting Commit Messages
67+
68+
We follow the conventions on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/).
69+
70+
Be sure to include any related GitHub issue references in the commit message. See
71+
[GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing issues
72+
and commits.
73+
74+
## Reporting Bugs and Creating Issues
75+
76+
When opening a new issue, try to roughly follow the commit message format conventions above.

0 commit comments

Comments
 (0)