Skip to content

Commit d3c03b3

Browse files
committed
customize repo template
1 parent 12682c3 commit d3c03b3

File tree

3 files changed

+23
-17
lines changed

3 files changed

+23
-17
lines changed

README.md

+5-13
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
1-
# Kubernetes Template Project
2-
3-
The Kubernetes Template Project is a template for starting new projects in the GitHub organizations owned by Kubernetes. All Kubernetes projects, at minimum, must have the following files:
4-
5-
- a `README.md` outlining the project goals, sponsoring sig, and community contact information
6-
- an `OWNERS` with the project leads listed as approvers ([docs on `OWNERS` files][owners])
7-
- a `CONTRIBUTING.md` outlining how to contribute to the project
8-
- the `code-of-conduct.md` from this repo, which outlines community behavior and the consequences of breaking the code
9-
- a `LICENSE` which must be Apache 2.0 for code projects, or Creative Commons 4.0 for documentation repositories
10-
- a `SECURITY_CONTACTS` with the contact points for the Product Security Team
11-
to reach out to for triaging and handling of incoming issues. They must agree to abide by the
12-
[Embargo Policy](https://github.com/kubernetes/sig-release/blob/master/security-release-process-documentation/security-release-process.md#embargo-policy)
13-
and will be removed and replaced if they violate that agreement.
1+
# Structured Merge and Diff
2+
3+
This repo contains code for implementing the Kubernetes "apply" operation.
4+
5+
It also contains test vectors for testing an implementation of apply.
146

157
## Community, discussion, contribution, and support
168

RELEASE.md

+17-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
11
# Release Process
22

3-
The Kubernetes Template Project is released on an as-needed basis. The process is as follows:
3+
This repo will follow go library versioning semantics.
4+
5+
Currently, it is not stable (version 0.0.0) and interfaces may change without
6+
warning.
7+
8+
Once it looks like this code will be used in a Kubernetes release, we will mark
9+
it v1.0.0 and any interface changes will begin accumulating in a v2 candidate.
10+
11+
We will publish versions in a way that's conformant with the new "go modules".
12+
13+
Reviewers / owners are expected to be vigilant about preventing
14+
interface-breaking changes in stable versions.
15+
16+
When a candidate version is ready to be promoted to stable, the process is as follows:
417

518
1. An issue is proposing a new release with a changelog since the last release
619
1. All [OWNERS](OWNERS) must LGTM this release
7-
1. An OWNER runs `git tag -s $VERSION` and inserts the changelog and pushes the tag with `git push $VERSION`
20+
1. An OWNER changes the name from vX-candidate to vX and starts a v(X+1)-candidate directory/module (details TBD when we first do this)
821
1. The release issue is closed
922
1. An announcement email is sent to `[email protected]` with the subject `[ANNOUNCE] kubernetes-template-project $VERSION is released`
23+
24+
(This process is currently intended to be a hint and will be refined once we declare our first stable release.)

SECURITY_CONTACTS

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,4 @@
1010
# DO NOT REPORT SECURITY VULNERABILITIES DIRECTLY TO THESE NAMES, FOLLOW THE
1111
# INSTRUCTIONS AT https://kubernetes.io/security/
1212

13-
bob
14-
alice
13+
lavalamp

0 commit comments

Comments
 (0)