Skip to content

Commit 4f6bd9c

Browse files
authored
add CONTRIBUTING, code of conduct, roadmap (ko-build#837)
1 parent 1c5a859 commit 4f6bd9c

File tree

3 files changed

+110
-0
lines changed

3 files changed

+110
-0
lines changed

CONTRIBUTING.md

+13
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,16 @@ All submissions, including submissions by project members, require review. We
2121
use GitHub pull requests for this purpose. Consult
2222
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
2323
information on using pull requests.
24+
25+
## Testing
26+
27+
Ensure the following passes:
28+
```
29+
./hack/presubmit.sh
30+
```
31+
and commit any resultant changes to `go.mod` and `go.sum`. To update any docs
32+
after client changes, run:
33+
34+
```
35+
./hack/update-codegen.sh
36+
```

ROADMAP.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# `ko` Project Roadmap
2+
3+
_Last updated October 2022_
4+
5+
- Foster a community of contributors and users
6+
- give talks, do outreach, expand the pool of contributors
7+
- identify projects that could benefit from using `ko`, and help onboard them
8+
- publish case studies from successful migrations
9+
10+
- Integrate [sigstore](https://sigstore.dev) for built artifacts
11+
- attach signed SBOMs
12+
- attach signed provenance attestations
13+
- support the OCI referrers API and [fallback tag scheme](https://github.com/opencontainers/distribution-spec/blob/main/spec.md#referrers-tag-schema)
14+
- integrate with CI workload identity (e.g., GitHub OIDC) to keylessly sign artifacts
15+
16+
- Faster builds
17+
- identify unnecessary work and avoid it when possible
18+
19+
- Ecosystem integrations
20+
- support Terraform provider, and potentially Pulumi and CDK, others
21+
- provide working examples of these integrations

code-of-conduct.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of
9+
experience, education, socio-economic status, nationality, personal appearance,
10+
race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or reject
41+
comments, commits, code, wiki edits, issues, and other contributions that are
42+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
43+
contributor for other behaviors that they deem inappropriate, threatening,
44+
offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
<!-- TODO: Need a real CoC contact list. -->
58+
59+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
60+
reported by contacting the project team. All complaints will be reviewed and
61+
investigated and will result in a response that is deemed necessary and
62+
appropriate to the circumstances. The project team is obligated to maintain
63+
confidentiality with regard to the reporter of an incident. Further details of
64+
specific enforcement policies may be posted separately.
65+
66+
Project maintainers who do not follow or enforce the Code of Conduct in good
67+
faith may face temporary or permanent repercussions as determined by other
68+
members of the project's leadership.
69+
70+
## Attribution
71+
72+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
73+
version 1.4, available at
74+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
75+
76+
[homepage]: https://www.contributor-covenant.org

0 commit comments

Comments
 (0)