Skip to content

Commit 7e4debb

Browse files
committed
docs: adding contribution guidelines and dco
Signed-off-by: Michael Hoang <[email protected]>
1 parent 85dc8a3 commit 7e4debb

File tree

3 files changed

+86
-0
lines changed

3 files changed

+86
-0
lines changed

CONTRIBUTING.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing
2+
3+
Contributions are welcome!
4+
5+
## Code of Conduct
6+
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+
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+
```
20+
Signed-off-by: First 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+
## Getting Started
26+
27+
### Issues
28+
29+
- Issues are tracked via the the [devfile/api](https://github.com/devfile/api) repo. Open or search for [issues](https://github.com/devfile/api/issues) with the label `area/landing-page`.
30+
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 landing-page`.
32+
33+
### Pull Requests
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 of the repository will watch out for and review new PRs.
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 afterward, so everyone gets notified by Github and knows to re-review.

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.

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,11 @@ Run `yarn install` to download dependencies.
2929
## landing-page
3030

3131
[Landing Page README](https://github.com/devfile/devfile-web/tree/main/apps/landing-page)
32+
33+
## Contributing
34+
35+
Please see our [contributing.md](./CONTRIBUTING.md).
36+
37+
## License
38+
39+
Apache License 2.0, see [LICENSE](./LICENSE) for details.

0 commit comments

Comments
 (0)