You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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]>
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+38-15
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,49 @@ Contributions are welcome!
6
6
7
7
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).
8
8
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,
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:
10
26
11
27
### Issues
12
28
13
29
- Open or search for [issues](https://github.com/devfile/api/issues) with the label `area/api`.
14
30
15
31
- 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`.
16
32
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
+
17
52
### Building
18
53
19
54
To build the CRD and the various schemas, you don't need to install any pre-requisite apart from `docker` or `podman`.
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
64
87
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.
0 commit comments