Skip to content

Commit 582eefa

Browse files
committed
docs: various updates
1 parent 3db76c0 commit 582eefa

File tree

8 files changed

+69
-169
lines changed

8 files changed

+69
-169
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,15 @@
11
## Description
22

3-
Please include a summary of the change and which issue is fixed. Please also
4-
include relevant motivation and context. List any dependencies that are required
5-
for this change.
3+
Please include a summary of the change.
64

75
Closes: #(issue-number)
86

9-
## Type of change
10-
11-
Please mark options that are relevant:
12-
13-
- [ ] Bug fix (non-breaking change which fixes an issue)
14-
- [ ] New feature (non-breaking change which adds functionality)
15-
- [ ] Breaking change (fix or feature that would cause existing functionality to
16-
not work as expected)
17-
- [ ] This change requires a documentation update
18-
- [ ] Build related change
19-
207
## How Has This Been Tested?
218

22-
Please describe the tests that you ran to verify your changes. Provide
23-
instructions so we can reproduce. If applicable, please also list any relevant
24-
details for your test configuration.
25-
26-
- [ ] Test Description 1
27-
- [ ] Test Description 2
9+
Please describe any manual tests done to verify your changes.
2810

29-
## Checklist:
11+
## Guidelines
3012

31-
- [ ] My code follows the `CONTRIBUTION` [guidelines] of this project
32-
- [ ] I have commented my code, particularly in hard-to-understand areas
33-
- [ ] I have made corresponding changes to the documentation
34-
- [ ] I have added tests that prove my fix is effective or that my feature works
35-
- [ ] New and existing unit tests pass locally with my changes
36-
- [ ] Any dependent changes have been merged
13+
Please read and follow the `CONTRIBUTION` [guidelines] of this project.
3714

3815
[guidelines]: https://github.com/vmware/govmomi/blob/main/CONTRIBUTING.md

.mailmap

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,9 @@ Yun Zhou <yunz@vmware.com> <41678287+gh05tn0va@users.noreply.github.com>
5757
Zach G <zguan@vmware.com> zach96guan <zach96guan@users.noreply.github.com>
5858
Zach Tucker <ztucker@vmware.com> <jzt@users.noreply.github.com>
5959
Zee Yang <zeey@vmware.com> <zee.yang@gmail.com>
60+
Arunesh Pandey <parunesh@vmware.com> Arunesh Pandey <aruneshpa@gmail.com>
61+
Eric Cao <ecao@vmware.com> Eric Cao <32748317+ericvmw@users.noreply.github.com>
62+
Eric Cao <ecao@vmware.com> Eric Cao <eric.cao@broadcom.com>
63+
Ryan Johnson <johnsonryan@vmware.com> Ryan Johnson <ryan.johnson@broadcom.com>
64+
Stoyan Zhelyazkov <stoyan.zhelyazkov@broadcom.com> Stoyan Zhelyazkov <156204153+spacegospod@users.noreply.github.com>
65+
Yanlei Zhao <yanleizhao@vmware.com> Yanlei Zhao <136122252+yanleizhao-vmware@users.noreply.github.com>

CONTRIBUTING.md

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Contributing to `govmomi`
22

3+
tl;dr
4+
5+
- Sign your commits, unless you've signed the CLA
6+
- Include a component `prefix:` in your commit message, if applicable
7+
- Squash fixup commits and force push to your branch
8+
39
## Getting started
410

511
First, fork the repository on GitHub to your personal account.
@@ -27,6 +33,7 @@ This is a rough outline of what a contributor's workflow looks like:
2733
- Create an issue describing the feature/fix
2834
- Create a topic branch from where you want to base your work.
2935
- Make commits of logical units.
36+
- [Sign](#sign-off-your-work) your commits.
3037
- Make sure your commit messages are in the proper format (see below).
3138
- Push your changes to a topic branch in your fork of the repository.
3239
- Submit a pull request to `vmware/govmomi`.
@@ -38,12 +45,30 @@ and **supported prefixes**, e.g. `govc: <message>`.
3845
> my!](https://www.mgasch.com/2021/05/git-basics/) for more details on how to
3946
> successfully contribute to an open source project.
4047
48+
### Sign-off Your Work
49+
50+
Use the [Developer Certificate of Origin](https://developercertificate.org/) (DCO) on all Pull Requests.
51+
By adding this line to their commit messages, contributors *sign-off* that they adhere to the requirements of the DCO.
52+
53+
Git provides the `-s` command-line option to append the required line
54+
automatically to the commit message:
55+
56+
```bash
57+
git commit -s -m 'This is my commit message'
58+
```
59+
60+
For an existing commit, you can also use this option with `--amend`:
61+
62+
```bash
63+
git commit -s --amend
64+
```
65+
4166
### Example 1 - Fix a Bug in `govmomi`
4267

4368
```bash
4469
git checkout -b issue-<number> main
4570
git add <files>
46-
git commit -m "fix: ..." -m "Closes: #<issue-number>"
71+
git commit -s -m "fix: ..." -m "Closes: #<issue-number>"
4772
git push $USER issue-<number>
4873
```
4974

@@ -52,7 +77,7 @@ git push $USER issue-<number>
5277
```bash
5378
git checkout -b issue-<number> main
5479
git add <files>
55-
git commit -m "Add API ..." -m "Closes: #<issue-number>"
80+
git commit -s -m "Add API ..." -m "Closes: #<issue-number>"
5681
git push $USER issue-<number>
5782
```
5883

@@ -61,26 +86,26 @@ git push $USER issue-<number>
6186
```bash
6287
git checkout -b issue-<number> main
6388
git add <files>
64-
git commit -m "govc: Add feature ..." -m "Closes: #<issue-number>"
89+
git commit -s -m "govc: Add feature ..." -m "Closes: #<issue-number>"
6590
git push $USER issue-<number>
6691
```
67-
**Note**:
92+
**Note**:
6893
To register the new `govc` command package, add a blank `_` import to `govmomi/govc/main.go`.
6994

7095
### Example 4 - Fix a Bug in `vcsim`
7196

7297
```bash
7398
git checkout -b issue-<number> main
7499
git add <files>
75-
git commit -m "vcsim: Fix ..." -m "Closes: #<issue-number>"
100+
git commit -s -m "vcsim: Fix ..." -m "Closes: #<issue-number>"
76101
git push $USER issue-<number>
77102
```
78103

79104
### Example 5 - Document Breaking (API) Changes
80105

81106
Breaking changes, e.g. to the `govmomi` APIs, are highlighted in the `CHANGELOG`
82107
and release notes when the keyword `BREAKING:` is used in the commit message
83-
body.
108+
body.
84109

85110
The text after `BREAKING:` is used in the corresponding highlighted section.
86111
Thus these details should be stated at the body of the commit message.
@@ -89,7 +114,7 @@ Multi-line strings are supported.
89114
```bash
90115
git checkout -b issue-<number> main
91116
git add <files>
92-
cat << EOF | git commit -F -
117+
cat << EOF | git commit -s -F -
93118
Add ctx to funcXYZ
94119
95120
This commit introduces context.Context to function XYZ
@@ -127,7 +152,7 @@ directly instead.
127152
git add .
128153

129154
# create a fixup commit which will be merged into your (original) <commit>
130-
git commit --fixup <commit>
155+
git commit -s --fixup <commit>
131156
git push $USER issue-<number>
132157
```
133158

@@ -162,7 +187,7 @@ e.g. `Closes: #<number>`.
162187
The [`CHANGELOG.md`](./CHANGELOG.md) and release page uses **commit message
163188
prefixes** for grouping and highlighting. A commit message that
164189
starts with `[prefix:] ` will place this commit under the respective
165-
section in the `CHANGELOG`.
190+
section in the `CHANGELOG`.
166191

167192
The following example creates a commit referencing the `issue: 1234` and puts
168193
the commit message in the `govc` `CHANGELOG` section:
@@ -186,7 +211,7 @@ is recommended to break up your commits using distinct prefixes.
186211

187212
### Running CI Checks and Tests
188213
You can run both `make check` and `make test` from the top level of the
189-
repository.
214+
repository.
190215

191216
While `make check` will catch formatting and import errors, it will not apply
192217
any fixes. The developer is expected to do that.

CONTRIBUTORS

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ abrarshivani <abrarshivani@users.noreply.github.com>
88
Adam Chalkley <atc0005@users.noreply.github.com>
99
Adam Fowler <adam@adamfowler.org>
1010
Adam Shannon <adamkshannon@gmail.com>
11+
Adnan Baruni <badnan@vmware.com>
1112
Akanksha Panse <pansea@vmware.com>
1213
Al Biheiri <abiheiri@apple.com>
1314
Alessandro Cortiana <alessandro.cortiana@gmail.com>
@@ -24,6 +25,7 @@ Andrew <AndrewDi@users.noreply.github.com>
2425
Andrew Chin <andrew@andrewtchin.com>
2526
Andrew Kutz <akutz@vmware.com>
2627
Andrey Klimentyev <andrey.klimentyev@flant.com>
28+
aneesurrehman001 <55150455+aneesurrehman001@users.noreply.github.com>
2729
Anfernee Yongkun Gui <agui@vmware.com>
2830
angystardust <angystardust@users.noreply.github.com>
2931
aniketGslab <aniket.shinde@gslab.com>
@@ -32,6 +34,7 @@ Ankit Vaidya <vaidyaa@vmware.com>
3234
Ankur Huralikoppi <huralikoppia@vmware.com>
3335
Anna Carrigan <anna.carrigan@hpe.com>
3436
Antony Saba <awsaba@gmail.com>
37+
Anusha Ramineni <raminenia@vmware.com>
3538
Ariel Chinn <arielchinn@gmail.com>
3639
Arran Walker <arran.walker@zopa.com>
3740
Artem Anisimov <aanisimov@inbox.ru>
@@ -46,6 +49,7 @@ Ben Vickers <bvickers@pivotal.io>
4649
Benjamin Davini <davinib@vmware.com>
4750
Benjamin Peterson <benjamin@python.org>
4851
Benjamin Vickers <bvickers@vmware.com>
52+
Bernd Zeimetz <bernd@bzed.de>
4953
Bhavya Choudhary <bhavyac@vmware.com>
5054
Bob Killen <killen.bob@gmail.com>
5155
Brad Fitzpatrick <bradfitz@golang.org>
@@ -57,6 +61,7 @@ Bruno Meneguello <1322552+bkmeneguello@users.noreply.github.com>
5761
Bryan Venteicher <bryanventeicher@gmail.com>
5862
C S P Nanda <cspn@google.com>
5963
Carsten Grohmann <mail@carstengrohmann.de>
64+
Chebrolu <hchebrol@redhat.com>
6065
Cheng Cheng <chengch@vmware.com>
6166
Chethan Venkatesh <chethanv@vmware.com>
6267
Choudhury Sarada Prasanna Nanda <cspn@google.com>
@@ -82,6 +87,7 @@ Davide Agnello <dagnello@hp.com>
8287
Davinder Kumar <davinderk@vmware.com>
8388
Defa <zhoudefa666@163.com>
8489
demarey <christophe.demarey@inria.fr>
90+
Derek Beard <derek.beard@gmail.com>
8591
Deric Crago <deric.crago@gmail.com>
8692
Deyan Popov <deyan.popov@gmail.com>
8793
Dinesh Bhat <35480850+dbhat-arkin@users.noreply.github.com>
@@ -92,12 +98,14 @@ Doug MacEachern <dougm@vmware.com>
9298
East <60801291+houfangdong@users.noreply.github.com>
9399
Eloy Coto <eloy.coto@gmail.com>
94100
Eng Zer Jun <engzerjun@gmail.com>
101+
Eric Cao <ecao@vmware.com>
95102
Eric Edens <ericedens@google.com>
96103
Eric Graham <16710890+Pheric@users.noreply.github.com>
97104
Eric Gray <egray@vmware.com>
98105
Eric Yutao <eric.yutao@gmail.com>
99106
Erik Hollensbe <github@hollensbe.org>
100107
Erik Lund <info@erikjensen.it>
108+
Erim Erdal <erim.erdal@broadcom.com>
101109
Essodjolo KAHANAM <essodjolo@kahanam.com>
102110
Ethan Kaley <ethan.kaley@emc.com>
103111
Evan Chu <echu@vmware.com>
@@ -121,6 +129,7 @@ Hasan Mahmood <mahmoodh@vmware.com>
121129
Haydon Ryan <haydon.ryan@gmail.com>
122130
Heiko Reese <hreese@users.noreply.github.com>
123131
Henrik Hodne <henrik@travis-ci.com>
132+
Himanshu Ranjan <rhimanshu@vmware.com>
124133
hkumar <hkumar@vmware.com>
125134
Hrabur Stoyanov <hstoyanov@vmware.com>
126135
hui luo <luoh@vmware.com>
@@ -135,10 +144,12 @@ Jeremy Canady <jcanady@jackhenry.com>
135144
jeremy-clerc <jeremy@clerc.io>
136145
Jiatong Wang <wjiatong@vmware.com>
137146
jingyizPensando <jingyiz@pensando.io>
147+
jitinkumar94 <jitinkumar94@github.com>
138148
Jonas Ausevicius <jonas.ausevicius@virtustream.com>
139149
Jorge Sevilla <jorge.sevilla@rstor.io>
140150
Joseph LeBlanc <jsleblanc@users.noreply.github.com>
141151
João Pereira <joaodrp@gmail.com>
152+
Jukka Lehtniemi <ext-jukka.lehtniemi@vaisala.com>
142153
Julien PILLON <jpillon@lesalternatives.org>
143154
Justin J. Novack <jnovack@users.noreply.github.com>
144155
kayrus <kay.diam@gmail.com>
@@ -155,6 +166,7 @@ Liping Xue <lipingx@vmware.com>
155166
liron.levin <liron.levin@wiz.io>
156167
Louie Jiang <jiangl@vmware.com>
157168
Lubron Zhan <lzhan@vmware.com>
169+
Luis Davim <dluis@vmware.com>
158170
Luther Monson <luther.monson@gmail.com>
159171
Madanagopal Arunachalam <marunachalam@vmware.com>
160172
makelarisjr <8687447+makelarisjr@users.noreply.github.com>
@@ -209,16 +221,19 @@ Robin Watkins <robwatkins@gmail.com>
209221
Rowan Jacobs <rojacobs@pivotal.io>
210222
Roy Ling <royling0024@gmail.com>
211223
rsikdar <rsikdar@berkeley.edu>
224+
rubinthomasdev <rubinthomasdev@gmail.com>
212225
runner.mei <runner.mei@gmail.com>
213226
Ryan Johnson <johnsonryan@vmware.com>
214227
S R Ashrith <sashrith@vmware.com>
215228
S.Çağlar Onur <conur@vmware.com>
216229
Saad Malik <saad@spectrocloud.com>
230+
Sai Diliyaer <sai.diliyaer@gmail.com>
217231
Sam Zhu <zhusa@zhusa-a02.vmware.com>
218232
samzhu333 <45263849+samzhu333@users.noreply.github.com>
219233
Sandeep Pissay Srinivasa Rao <ssrinivas@vmware.com>
220234
schmikei <keith.schmitt@bluemedora.com>
221235
Scott Holden <scott@nullops.io>
236+
Sebastian Mitterle <smitterl@redhat.com>
222237
Sergey Ignatov <sergey.ignatov@jetbrains.com>
223238
serokles <timbo.alexander@gmail.com>
224239
shahra <shahra@vmware.com>
@@ -229,6 +244,7 @@ shylasrinivas <sshyla@vmware.com>
229244
sky-joker <sky.jokerxx@gmail.com>
230245
smaftoul <samuel.maftoul@gmail.com>
231246
smahadik <smahadik@vmware.com>
247+
Sreeja Acharya <acharyasreej@vmware.com>
232248
Sten Feldman <exile@chamber.ee>
233249
Stepan Mazurov <smazurov@gmail.com>
234250
Steve Purcell <steve@sanityinc.com>
@@ -264,6 +280,7 @@ xing-yang <xingyang105@gmail.com>
264280
xinyanw409 <wxinyan@vmware.com>
265281
Yang Yang <yangy@vmware.com>
266282
yangxi <yangxi@vmware.com>
283+
Yanlei Zhao <yanleizhao@vmware.com>
267284
Yann Hodique <yhodique@google.com>
268285
Yash Nitin Desai <desaiy@vmware.com>
269286
Yassine TIJANI <ytijani@vmware.com>

0 commit comments

Comments
 (0)