Skip to content

Commit 3ab77a5

Browse files
Update contributing guide (#1597)
* contributing guide updates Signed-off-by: Michael Valdron <[email protected]> * add missing DCO Signed-off-by: Michael Valdron <[email protected]> * link CODEOWNERS file in mention of owners Signed-off-by: Michael Valdron <[email protected]> * link community devfile slack channel in mention of it Signed-off-by: Michael Valdron <[email protected]> --------- Signed-off-by: Michael Valdron <[email protected]>
1 parent cfbdc2b commit 3ab77a5

File tree

2 files changed

+75
-15
lines changed

2 files changed

+75
-15
lines changed

CONTRIBUTING.md

+38-15
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,49 @@ Contributions are welcome!
66

77
Before contributing to this repository for the first time, please review our project's [Code of Conduct](https://github.com/devfile/api/blob/main/CODE_OF_CONDUCT.md).
88

9-
## Getting Started
9+
## Certificate of Origin
10+
11+
By contributing to this project you agree to the Developer Certificate of
12+
Origin (DCO). This document was created by the Linux Kernel community and is a
13+
simple statement that you, as a contributor, have the legal right to make the
14+
contribution. See the [DCO](DCO) file for details.
15+
16+
In order to show your agreement with the DCO you should include at the end of the commit message,
17+
the following line:
18+
19+
```console
20+
Signed-off-by: Firstname Lastname <[email protected]>
21+
```
22+
23+
Once you set your user.name and user.email in your git config, you can sign your commit automatically with `git commit -s`.
24+
25+
## How to Contribute:
1026

1127
### Issues
1228

1329
- Open or search for [issues](https://github.com/devfile/api/issues) with the label `area/api`.
1430

1531
- If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/devfile/api/issues/new/choose). You can tag issues with `/area api`.
1632

33+
### Submitting Pull Request
34+
35+
When you think the code is ready for review, create a pull request and link the issue associated with it.
36+
37+
[Owners](.github/CODEOWNERS) of the repository will watch out for new PRs and provide reviews to them.
38+
39+
If comments have been given in a review, they have to be addressed before merging.
40+
41+
After addressing review comments, don't forget to add a comment in the PR with the reviewer mentioned afterward, so they get notified by Github to provide a re-review.
42+
43+
### Prerequisites
44+
45+
The following are required to build the CRDs and TypeScript models containing your changes:
46+
47+
- Docker or Podman
48+
- Git
49+
50+
Testing requires Go 1.21+ to be installed.
51+
1752
### Building
1853

1954
To build the CRD and the various schemas, you don't need to install any pre-requisite apart from `docker` or `podman`.
@@ -48,18 +83,6 @@ cd test/v200/apiTest
4883
go test -v
4984
```
5085

51-
### Pull Requests
52-
53-
All commits must be signed off with the footer:
54-
55-
```git
56-
Signed-off-by: Firstname Lastname <[email protected]>
57-
```
58-
59-
Once you set your user.name and user.email in your git config, you can sign your commit automatically with git commit -s. When you think the code is ready for review, create a pull request and link the issue associated with it.
60-
61-
Owners of the repository will watch out for and review new PRs.
62-
63-
If comments have been given in a review, they have to be addressed before merging.
86+
# Contact us
6487

65-
After addressing review comments, don’t forget to add a comment in the PR afterward, so everyone gets notified by Github and knows to re-review.
88+
If you have any questions, please visit us the [`#devfile` channel](https://kubernetes.slack.com/archives/C02SX9E5B55) under the [Kubernetes Slack](https://slack.k8s.io) workspace.

DCO

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

0 commit comments

Comments
 (0)