mirror of https://github.com/knative/community.git
Update REPOSITORY-GUIDELINES to include knative-sandbox. (#149)
* Add proposal from community#130 to REPOSITORY-GUIDELINES.md * Apply typo fixes from lionelvillard * Address pmorie feedback
This commit is contained in:
Evan Anderson
GitHub
parent
ebe7933510
commit
cc8dac1911
|
|
@ -1,101 +1,194 @@
|
||||||
---
|
---
|
||||||
title: "Knative Repository Guidelines"
|
title: "Knative Repository Guidelines"
|
||||||
linkTitle: "Repository Guidelines"
|
linkTitle: "Repository Guidelines"
|
||||||
weight: 25
|
weight: 25
|
||||||
type: "docs"
|
type: "docs"
|
||||||
aliases:
|
aliases:
|
||||||
- /contributing/repository-guidelines/
|
- /contributing/repository-guidelines/
|
||||||
---
|
---
|
||||||
|
|
||||||
This document outlines a structure for creating and associating code
|
This document outlines a structure for creating and associating code
|
||||||
repositories with the Knative project. It also describes how and when
|
repositories with the Knative project. It also describes how and when
|
||||||
repositories are removed.
|
repositories are removed.
|
||||||
|
|
||||||
## Core Repositories
|
## Core Repositories
|
||||||
|
|
||||||
Core repositories are considered core components of Knative. They are utilities,
|
Core repositories are considered core components of Knative. They are utilities,
|
||||||
tools, applications, or libraries that form or support the foundation of the
|
tools, applications, or libraries that form or support the foundation of the
|
||||||
project.
|
project.
|
||||||
|
|
||||||
Core repositories are all those located under the
|
Core repositories are all those located under the
|
||||||
[github.com/knative organization](https://github.com/knative).
|
[github.com/knative organization](https://github.com/knative).
|
||||||
|
|
||||||
### Core Repository Requirements
|
### Core Repository Requirements
|
||||||
|
|
||||||
- Repository must live under github.com/knative/project-name.
|
- Repository must live under github.com/knative/project-name.
|
||||||
- Must adopt the Knative Code of Conduct.
|
- Must adopt the Knative Code of Conduct.
|
||||||
- All code projects must use the Apache License version 2.0.
|
- All code projects must use the Apache License version 2.0.
|
||||||
- Documentation repositories must use Creative Commons License version 4.0.
|
- Documentation repositories must use Creative Commons License version 4.0.
|
||||||
- All OWNERS must be members of the Knative community.
|
- All OWNERS must be members of the Knative community.
|
||||||
- Repository creation must be approved by the Technical Oversight Committee.
|
- Repository creation must be approved by the Technical Oversight Committee.
|
||||||
|
|
||||||
### Requirements for Repository Donation
|
### Requirements for Repository Donation
|
||||||
|
|
||||||
The Technical Oversight Committee may allow repositories to be donated to the
|
The Technical Oversight Committee may allow repositories to be donated to the
|
||||||
Knative project. In *addition* to meeting the core repository requirements,
|
Knative project. In _addition_ to meeting the core repository requirements,
|
||||||
donated repositories must:
|
donated repositories must:
|
||||||
|
|
||||||
- Adopt the Google CLA bot.
|
- Adopt the Google CLA bot.
|
||||||
- All contributors to the donated repository must have signed the Google CLA.
|
- All contributors to the donated repository must have signed the Google CLA.
|
||||||
- All code must adopt the standard Knative header, attributing copyright as follows:
|
- All code must adopt the standard Knative header, attributing copyright as
|
||||||
`"Copyright <year> The Knative Authors"`
|
follows: `"Copyright <year> The Knative Authors"`
|
||||||
- Additions of the standard Knative header to code created by the contributors can
|
- Additions of the standard Knative header to code created by the contributors
|
||||||
occur post-transfer, but should ideally occur shortly thereafter.
|
can occur post-transfer, but should ideally occur shortly thereafter.
|
||||||
- An `AUTHORS` file should be created in the repo root, if one does not already exist, that
|
- An `AUTHORS` file should be created in the repo root, if one does not already
|
||||||
includes the original authors of the code.
|
exist, that includes the original authors of the code. See
|
||||||
See [knative/serving AUTHORS](https://github.com/knative/serving/blob/master/AUTHORS) for reference.
|
[knative/serving AUTHORS](https://github.com/knative/serving/blob/master/AUTHORS)
|
||||||
- Note that copyright notices should only be modified or removed by the people or organizations named in the notice.
|
for reference.
|
||||||
|
- Note that copyright notices should only be modified or removed by the people
|
||||||
## Removing Repositories
|
or organizations named in the notice.
|
||||||
|
|
||||||
As important as it is to add new repositories, it is equally important to prune
|
## Removing Repositories
|
||||||
repositories when necessary. See [Grounds for removal](#grounds-for-removal).
|
|
||||||
|
As important as it is to add new repositories, it is equally important to prune
|
||||||
It is important to the success of Knative that all Knative repositories stay
|
repositories when necessary. See [Grounds for removal](#grounds-for-removal).
|
||||||
active, healthy, and aligned with the scope and mission of project.
|
|
||||||
|
It is important to the success of Knative that all Knative repositories stay
|
||||||
### Grounds for removal
|
active, healthy, and aligned with the scope and mission of project.
|
||||||
|
|
||||||
Core repositories may be removed from the project if they are deemed _inactive_.
|
### Grounds for removal
|
||||||
Inactive repositories are those that meet any of the following criteria:
|
|
||||||
|
Core repositories may be removed from the project if they are deemed _inactive_.
|
||||||
- There are no longer any active maintainers for the project, and no
|
Inactive repositories are those that meet any of the following criteria:
|
||||||
replacements can be found.
|
|
||||||
- All PRs and issues have gone un-addressed for longer than six months.
|
- There are no longer any active maintainers for the project, and no
|
||||||
- There have been no new commits or other changes in more than a year.
|
replacements can be found.
|
||||||
- The contents have been folded into another actively maintained project.
|
- All PRs and issues have gone un-addressed for longer than six months.
|
||||||
|
- There have been no new commits or other changes in more than a year.
|
||||||
### Procedure for removal
|
- The contents have been folded into another actively maintained project.
|
||||||
|
|
||||||
When a repository has been deemed eligible for removal, we take the following
|
### Procedure for removal
|
||||||
steps:
|
|
||||||
|
When a repository has been deemed eligible for removal, we take the following
|
||||||
- A proposal to remove the repository is brought to the attention of the
|
steps:
|
||||||
Technical Oversight Committee through a GitHub issue posted in the
|
|
||||||
[docs](https://github.com/knative/docs) repo.
|
- A proposal to remove the repository is brought to the attention of the
|
||||||
- Feedback is encouraged during a Technical Oversight Committee meeting before
|
Technical Oversight Committee through a GitHub issue posted in the
|
||||||
any action is taken.
|
[community](https://github.com/knative/community) repo.
|
||||||
- Once the TOC has approved of the removal, if the repo is not moving to another
|
- Feedback is encouraged during a Technical Oversight Committee meeting before
|
||||||
actively maintained project:
|
any action is taken.
|
||||||
- The repo description is edited to start with the phrase "[EOL]"
|
- Once the TOC has approved of the removal, if the repo is not moving to another
|
||||||
- All open issues and PRs are closed
|
actively maintained project:
|
||||||
- All external collaborates are removed
|
- The repo description is edited to start with the phrase "[EOL]"
|
||||||
- All webhooks, apps, integrations, or services are removed
|
- All open issues and PRs are closed
|
||||||
- GitHub pages are disabled
|
- All external collaborates are removed
|
||||||
- The repo is marked as archived using GitHub's archive feature
|
- All webhooks, apps, integrations, or services are removed
|
||||||
- The removal is announced on the knative-dev mailing list
|
- GitHub pages are disabled
|
||||||
|
- The repo is marked as archived using GitHub's archive feature
|
||||||
This procedure maintains the complete record of issues, PRs, and other
|
- The removal is announced on the knative-dev mailing list
|
||||||
contributions. It leaves the repository read-only and makes it clear that the
|
|
||||||
repository is retired and no longer maintained.
|
This procedure maintains the complete record of issues, PRs, and other
|
||||||
|
contributions. It leaves the repository read-only and makes it clear that the
|
||||||
---
|
repository is retired and no longer maintained.
|
||||||
|
|
||||||
Contents of this page are adopted from the
|
## Additional / Experimental Repositories
|
||||||
[Kubernetes repository guidelines](https://github.com/kubernetes/community/blob/master/github-management/kubernetes-repositories.md),
|
|
||||||
which is licensed under Apache License 2.0.
|
We want Knative working groups to be able to own code outside the core `knative`
|
||||||
|
organization, which is kept intentionally small and has a high bar for entry.
|
||||||
Except as otherwise noted, the content of this page is licensed under the
|
The `knative-sandbox` github organization was created for this purpose.
|
||||||
[Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/),
|
Repositories in `knative-sandbox` are intended to give working groups more
|
||||||
and code samples are licensed under the
|
latitude to experiment with new ideas and to self-organize and manage
|
||||||
[Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
|
contributions which may be important to the project but which do not need the
|
||||||
|
level of governance of the core project.
|
||||||
|
|
||||||
|
Note that `knative-sandbox` is **not** an incubation area for projects entering
|
||||||
|
the core; in some cases, projects in the sandbox will remain there for the
|
||||||
|
entire duration. Promotion from the sandbox into core will be handled on a
|
||||||
|
case-by-case basis by joint decision of the Steering Committee and the Technical
|
||||||
|
Oversight Committee.
|
||||||
|
|
||||||
|
### Mechanics of working-group owned repositories in `knative-sandbox`
|
||||||
|
|
||||||
|
#### Creation
|
||||||
|
|
||||||
|
Note: prior art here from the
|
||||||
|
[Kubernetes community](https://github.com/kubernetes/community/blob/master/github-management/kubernetes-repositories.md).
|
||||||
|
|
||||||
|
Working groups should be able to create repositories that meet the following
|
||||||
|
bar:
|
||||||
|
|
||||||
|
- Vendor independent (no direct links to specific clouds, no required
|
||||||
|
dependencies on vendor-specific tools)
|
||||||
|
|
||||||
|
- Homed within an existing working group (if you want a new working group too,
|
||||||
|
create the working group first)
|
||||||
|
|
||||||
|
- Must adopt the Knative CLA
|
||||||
|
|
||||||
|
- Must adopt the Knative
|
||||||
|
[code of conduct](https://github.com/knative/community/blob/master/CODE-OF-CONDUCT.md)
|
||||||
|
|
||||||
|
- Must adopt the Apache 2.0 license
|
||||||
|
|
||||||
|
- Must be sponsored by a specific working group, which should be designated in
|
||||||
|
the `README.md` for the repo. In addition, at least one WG lead must be in the
|
||||||
|
root-level OWNERS file.
|
||||||
|
|
||||||
|
- Copyright assigned to The Knative Authors
|
||||||
|
|
||||||
|
- Document clear release and install processes.
|
||||||
|
|
||||||
|
- Clearly document the stability and API guarantees (both in the top-level
|
||||||
|
`README.md` and by using appropriate API versioning for Kubernetes apigroups).
|
||||||
|
|
||||||
|
- Kubernetes APIs must be homed in a valid group with a DNS prefix approved by
|
||||||
|
the Steering Committee.
|
||||||
|
|
||||||
|
- APIs under `knative.dev` should:
|
||||||
|
|
||||||
|
1. Be under a subdomain managed by the owning Working Group (e.g.
|
||||||
|
`sources.knative.dev`, not `knative.dev`). The TOC is considered the
|
||||||
|
authority for assigning subdomains to working groups.
|
||||||
|
|
||||||
|
1. Coordinate with the Working Group in API naming to avoid collisions or
|
||||||
|
confusing naming. This also includes API review by the responsible
|
||||||
|
Working Group to ensure consistency and alignment with duck-type field
|
||||||
|
naming.
|
||||||
|
|
||||||
|
Working groups must designate the repositories they own (specifics TBD).
|
||||||
|
|
||||||
|
Repositories owned by working groups are encouraged to embrace the project value
|
||||||
|
of pluggability.
|
||||||
|
|
||||||
|
### Non-requirements
|
||||||
|
|
||||||
|
The following are not required to create a working-group-owned repository:
|
||||||
|
|
||||||
|
- Steering approval (see ["the fine print"](#the-fine-print))
|
||||||
|
- TOC approval
|
||||||
|
- Solving an unique problem (exploring different approaches to problems outside
|
||||||
|
the core is actively encouraged!)
|
||||||
|
|
||||||
|
### The fine print
|
||||||
|
|
||||||
|
Steering reserves the right to require that repos be removed or transferred out
|
||||||
|
of the `knative-sandbox` organization (and API groups to be renamed). This is
|
||||||
|
intended to simplify the process in the common case, while giving Steering the
|
||||||
|
ability to step in and rectify problems that may arise.
|
||||||
|
|
||||||
|
### Deletion
|
||||||
|
|
||||||
|
Working groups are responsible for the upkeep of their repositories and are
|
||||||
|
expected to keep a high quality bar. Inactive repositories should be archived,
|
||||||
|
deleted, or moved out of the `knative-sandbox` organization.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Contents of this page are adopted from the
|
||||||
|
[Kubernetes repository guidelines](https://github.com/kubernetes/community/blob/master/github-management/kubernetes-repositories.md),
|
||||||
|
which is licensed under Apache License 2.0.
|
||||||
|
|
||||||
|
Except as otherwise noted, the content of this page is licensed under the
|
||||||
|
[Creative Commons Attribution 4.0 License](https://creativecommons.org/licenses/by/4.0/),
|
||||||
|
and code samples are licensed under the
|
||||||
|
[Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue