Skip to content

Commit c1831da

Browse files
Adding instruction for copyright notices (#4366)
* Adding instruction for copyright notices Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> * Apply suggestions from code review Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech> * Fixing the copyright notice example Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> --------- Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com> Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
1 parent 22b9a53 commit c1831da

1 file changed

Lines changed: 33 additions & 18 deletions

File tree

CONTRIBUTING.md

Lines changed: 33 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# How to Contribute
22

33
We'd love to accept your patches and contributions to this project. To learn more about the project structure and
4-
organization, please refer to Project [Governance](https://github.com/kptdev/governance) information. There are just a few small guidelines you
5-
need to follow.
4+
organization, please refer to Project [Governance](https://github.com/kptdev/governance) information. There are just a
5+
few small guidelines you need to follow.
66

77
## Developer Certificate of Origin (DCO)
88

@@ -11,10 +11,37 @@ for their contribution. To do this when creating a commit with the Git CLI, a si
1111
[the -s option](https://git-scm.com/docs/git-commit#git-commit--s). The sign-off is stored as part of the commit message
1212
itself.
1313

14+
## Copyright notices
15+
16+
All files should have the copyright notice.
17+
```
18+
// Copyright 2025 The kpt Authors
19+
//
20+
// Licensed under the Apache License, Version 2.0 (the "License");
21+
// you may not use this file except in compliance with the License.
22+
// You may obtain a copy of the License at
23+
//
24+
// http://www.apache.org/licenses/LICENSE-2.0
25+
//
26+
// Unless required by applicable law or agreed to in writing, software
27+
// distributed under the License is distributed on an "AS IS" BASIS,
28+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
29+
// See the License for the specific language governing permissions and
30+
// limitations under the License.
31+
```
32+
33+
If the file has never been modified: use the creation year only
34+
35+
* Example: `Copyright 2025 The kpt Authors`
36+
37+
If the file has been modified: use a year range from creation to last modification
38+
39+
* Example: `Copyright 2024-2026 The kpt Authors`
40+
1441
## Contributing large features
1542

1643
Larger features and all the features that affect the interface (CLI or API) of
17-
kpt components need to have a reviewed and merged design document. It is OK to
44+
kpt components need to have a reviewed and merged design document. It is OK to
1845
start with a prototype in your private fork but if you intend for your feature
1946
to be shipped in kpt please create a design document with this
2047
[design template](/docs/design-docs/00-template.md).
@@ -94,7 +121,7 @@ changes and PR description should start with `Docs:`.
94121
#### Run the docs locally
95122

96123
Make docs changes and test them by running the site in a docker container with
97-
`make site-run-server`.
124+
`make serve`.
98125

99126
It's usually a good idea to test locally for the following:
100127

@@ -103,21 +130,9 @@ It's usually a good idea to test locally for the following:
103130

104131
#### Update docs
105132

106-
Docs are under [site/] and use [docsify] to present the source markdown files.
107-
The sidebar is automatically updated for the site at deployment time.
108-
109-
#### Docs Hygiene
110-
111-
The kpt website uses markdownlint to lint docs for formatting and style. Use
112-
prettier with the `"prettier.proseWrap": "always"` setting to auto-format docs
113-
in VSCode.
114-
115-
This includes:
133+
Docs are under [documentation/]. Refer to (the README,md)[documentation/README.md] in the folder to details about
134+
documentation contributions.
116135

117-
- Lint docs with markdownlint to standardize them and make them easier to
118-
update.
119-
- Run the kpt website through the [W3 Link Checker] in recursive mode and fix
120-
warnings and errors.
121136

122137
[error message style guide]: docs/style-guides/errors.md
123138
[documentation style guide]: docs/style-guides/docs.md

0 commit comments

Comments
 (0)