Skip to content

Commit ece6e8b

Browse files
committed
doc: automated a record of all-time contributors
We want to produce a simple acknowledgement report, nothing too fancy. Also: refactored CONTRIBUTING guidelines to refer to DCO terms. Signed-off-by: Frederic BIDON <[email protected]>
1 parent 61efbb7 commit ece6e8b

File tree

3 files changed

+100
-43
lines changed

3 files changed

+100
-43
lines changed

.github/CONTRIBUTING.md

Lines changed: 17 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,20 @@ These guidelines are general to all libraries published on github by the `go-ope
1313

1414
You'll find more detailed (or repo-specific) instructions in the [maintainer's docs](../docs).
1515

16-
## Questions & Issues
16+
## How can I contribute?
17+
18+
There are many ways in which you can contribute. Here are a few ideas:
19+
20+
* Reporting Issues / Bugs
21+
* Suggesting Improvements
22+
* Code
23+
* bug fixes and new features that are within the main project scope
24+
* improving test coverage
25+
* addressing code quality issues
26+
* Documentation
27+
* Art work that makes the project look great
28+
29+
## Questions & issues
1730

1831
### Asking questions
1932

@@ -189,49 +202,10 @@ pass it on as an open-source patch.
189202
We require the simple DCO below with an email signing your commit.
190203
PGP-signed commit are greatly appreciated but not required.
191204

192-
The rules are pretty simple: if you can certify the below (from
193-
[developercertificate.org](http://developercertificate.org/)):
194-
195-
```
196-
Developer Certificate of Origin
197-
Version 1.1
198-
199-
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
200-
660 York Street, Suite 102,
201-
San Francisco, CA 94110 USA
202-
203-
Everyone is permitted to copy and distribute verbatim copies of this
204-
license document, but changing it is not allowed.
205-
206-
207-
Developer's Certificate of Origin 1.1
208-
209-
By making a contribution to this project, I certify that:
210-
211-
(a) The contribution was created in whole or in part by me and I
212-
have the right to submit it under the open source license
213-
indicated in the file; or
214-
215-
(b) The contribution is based upon previous work that, to the best
216-
of my knowledge, is covered under an appropriate open source
217-
license and I have the right under that license to submit that
218-
work with modifications, whether created in whole or in part
219-
by me, under the same open source license (unless I am
220-
permitted to submit under a different license), as indicated
221-
in the file; or
222-
223-
(c) The contribution was provided directly to me by some other
224-
person who certified (a), (b) or (c) and I have not modified
225-
it.
226-
227-
(d) I understand and agree that this project and the contribution
228-
are public and that a record of the contribution (including all
229-
personal information I submit with it, including my sign-off) is
230-
maintained indefinitely and may be redistributed consistent with
231-
this project or the open source license(s) involved.
232-
```
205+
The rules are pretty simple:
233206

234-
then you just add a line to every git commit message:
207+
* read our [DCO](./DCO.md) (from [developercertificate.org](http://developercertificate.org/))
208+
* if you agree with these terms, then you just add a line to every git commit message
235209

236210
Signed-off-by: Joe Smith <[email protected]>
237211

.github/DCO.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Developer's Certificate of Origin
2+
3+
```
4+
Developer Certificate of Origin
5+
Version 1.1
6+
7+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
8+
660 York Street, Suite 102,
9+
San Francisco, CA 94110 USA
10+
11+
Everyone is permitted to copy and distribute verbatim copies of this
12+
license document, but changing it is not allowed.
13+
14+
15+
Developer's Certificate of Origin 1.1
16+
17+
By making a contribution to this project, I certify that:
18+
19+
(a) The contribution was created in whole or in part by me and I
20+
have the right to submit it under the open source license
21+
indicated in the file; or
22+
23+
(b) The contribution is based upon previous work that, to the best
24+
of my knowledge, is covered under an appropriate open source
25+
license and I have the right under that license to submit that
26+
work with modifications, whether created in whole or in part
27+
by me, under the same open source license (unless I am
28+
permitted to submit under a different license), as indicated
29+
in the file; or
30+
31+
(c) The contribution was provided directly to me by some other
32+
person who certified (a), (b) or (c) and I have not modified
33+
it.
34+
35+
(d) I understand and agree that this project and the contribution
36+
are public and that a record of the contribution (including all
37+
personal information I submit with it, including my sign-off) is
38+
maintained indefinitely and may be redistributed consistent with
39+
this project or the open source license(s) involved.
40+
```

.github/workflows/contributors.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: contributors
2+
3+
permissions:
4+
contents: read
5+
6+
on:
7+
push:
8+
branches: [ "master" ]
9+
10+
jobs:
11+
update-contributors:
12+
name: all-time contributors
13+
permissions:
14+
contents: write
15+
runs-on: ubuntu-latest
16+
steps:
17+
-
18+
name: Checkout repository
19+
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
20+
-
21+
name: Identify all-time contributors to this repository
22+
id: report-contributors
23+
uses: github/contributors@8b7586939baa0af4e801dbd22c88adf6e0db8915 # v1.7.5
24+
env:
25+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26+
REPOSITORY: ${{ github.repository }}
27+
LINK_TO_PROFILE: "true"
28+
-
29+
name: Rename contributor file
30+
run: |
31+
mv contributors.md EMERITUS.md
32+
-
33+
name: Create a PR
34+
uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
35+
with:
36+
commit-message: "doc: updated contributors file"
37+
branch: doc/contributors-bot-${{ github.run_id}}
38+
delete-branch: true
39+
title: "doc: updated contributors file"
40+
token: ${{ secrets.GITHUB_TOKEN }}
41+
label: "bot"
42+
assignees: fredbi
43+
reviewers: fredbi

0 commit comments

Comments
 (0)