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]>
devfile · Jun 14, 2024 · 3ab77a5 · 3ab77a5
1 parent cfbdc2b
commit 3ab77a5
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 15 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,14 +6,49 @@ Contributions are welcome!
 
 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).
 
-## Getting Started
+## Certificate of Origin
+
+By contributing to this project you agree to the Developer Certificate of
+Origin (DCO). This document was created by the Linux Kernel community and is a
+simple statement that you, as a contributor, have the legal right to make the
+contribution. See the [DCO](DCO) file for details.
+
+In order to show your agreement with the DCO you should include at the end of the commit message,
+the following line:
+
+```console
+Signed-off-by: Firstname Lastname <[email protected]>
+```
+
+Once you set your user.name and user.email in your git config, you can sign your commit automatically with `git commit -s`.
+
+## How to Contribute:
 
 ### Issues
 
 - Open or search for [issues](https://github.com/devfile/api/issues) with the label `area/api`.
 
 - 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`.
 
+### Submitting Pull Request
+
+When you think the code is ready for review, create a pull request and link the issue associated with it.
+
+[Owners](.github/CODEOWNERS) of the repository will watch out for new PRs and provide reviews to them.
+
+If comments have been given in a review, they have to be addressed before merging.
+
+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.
+
+### Prerequisites
+
+The following are required to build the CRDs and TypeScript models containing your changes:
+
+- Docker or Podman
+- Git
+
+Testing requires Go 1.21+ to be installed.
+
 ### Building
 
 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
 go test -v
 ```
 
-### Pull Requests
-
-All commits must be signed off with the footer:
-
-```git
-Signed-off-by: Firstname Lastname <[email protected]>
-```
-
-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.
-
-Owners of the repository will watch out for and review new PRs.
-
-If comments have been given in a review, they have to be addressed before merging.
+# Contact us
 
-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.
+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.
diff --git a/DCO b/DCO
@@ -0,0 +1,37 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.