Skip to content

Adding instruction for copyright notices #4366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liamfallon merged 3 commits into from
Jan 29, 2026
Merged

Adding instruction for copyright notices #4366

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e202b5c
Adding instruction for copyright notices
CsatariGergely Jan 22, 2026
c2659f7
Apply suggestions from code review
CsatariGergely Jan 28, 2026
3711227
Fixing the copyright notice example
CsatariGergely Jan 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 33 additions & 18 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# How to Contribute

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

## Developer Certificate of Origin (DCO)

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

## Copyright notices

All files should have the copyright notice.
```
// Copyright 2025 The kpt Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
```

If the file has never been modified: use the creation year only

* Example: `Copyright 2025 The kpt Authors`

If the file has been modified: use a year range from creation to last modification

* Example: `Copyright 2024-2026 The kpt Authors`

## Contributing large features

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

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

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

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

#### Update docs

Docs are under [site/] and use [docsify] to present the source markdown files.
The sidebar is automatically updated for the site at deployment time.

#### Docs Hygiene

The kpt website uses markdownlint to lint docs for formatting and style. Use
prettier with the `"prettier.proseWrap": "always"` setting to auto-format docs
in VSCode.

This includes:
Docs are under [documentation/]. Refer to (the README,md)[documentation/README.md] in the folder to details about
documentation contributions.

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

[error message style guide]: docs/style-guides/errors.md
[documentation style guide]: docs/style-guides/docs.md
Expand Down
Loading