Skip to content

Commit c502b6a

Browse files
authored
update project docs (#600)
1 parent e7d9e9f commit c502b6a

File tree

3 files changed

+3
-106
lines changed

3 files changed

+3
-106
lines changed

CODE_OF_CONDUCT.md

+1-76
Original file line numberDiff line numberDiff line change
@@ -1,76 +1 @@
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 this project
7-
and our community a harassment-free experience for everyone, regardless of
8-
age, body size, disability, ethnicity, sex characteristics, gender identity and
9-
expression, level of experience, education, socio-economic status, nationality,
10-
personal appearance, 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
41-
reject comments, commits, code, wiki edits, issues, and other contributions
42-
that are not aligned to this Code of Conduct, or to ban temporarily or
43-
permanently any contributor for other behaviors that they deem inappropriate,
44-
threatening, 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-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58-
reported by contacting the project team at [email protected]. All
59-
complaints will be reviewed and investigated and will result in a response that
60-
is deemed necessary and appropriate to the circumstances. The project team is
61-
obligated to maintain confidentiality with regard to the reporter of an incident.
62-
Further details of specific enforcement policies may be posted separately.
63-
64-
Project maintainers who do not follow or enforce the Code of Conduct in good
65-
faith may face temporary or permanent repercussions as determined by other
66-
members of the project's leadership.
67-
68-
## Attribution
69-
70-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72-
73-
[homepage]: https://www.contributor-covenant.org
74-
75-
For answers to common questions about this code of conduct, see
76-
https://www.contributor-covenant.org/faq
1+
https://carvel.dev/shared/docs/latest/code-of-conduct/

CONTRIBUTING.md

+1-27
Original file line numberDiff line numberDiff line change
@@ -1,27 +1 @@
1-
# How to Contribute
2-
3-
We’d love to accept your patches and contributions to this project. Please review the following guidelines you'll need to follow in order to make a contribution.
4-
5-
# Communication
6-
7-
We prefer communicating asynchronously through GitHub issues and the [#carvel Slack channel](https://kubernetes.slack.com/archives/CH8KCCKA5). In order to be inclusive to the community, if a conversation related to an issue happens outside of these channels, we appreciate summarizing the conversation's context and adding it to an issue.
8-
9-
# Propose a Change
10-
11-
Pull requests are welcome for all changes. When adding new functionality, we encourage including test coverage. If significant effort will be involved, we suggest beginning by submitting an issue so any high level feedback can be addressed early.
12-
13-
Please submit feature requests and bug reports by using GitHub issues.
14-
15-
Before submitting an issue, please search through open ones to ensure others have not submitted something similar. If a similar issue exists, please add any additional information as a comment.
16-
17-
## Issues Lifecycle
18-
19-
Once an issue is labeled with `in-progress`, a team member has begun investigating it. We keep `in-progress` issues open until they have been resolved and released. Once released, a comment containing release information will be posted in the issue's thread.
20-
21-
# Contributor License Agreement
22-
23-
All contributors to this project must have a signed Contributor License Agreement (**"CLA"**) on file with us. The CLA grants us the permissions we need to use and redistribute your contributions as part of the project; you or your employer retain the copyright to your contribution. Before a PR can pass all required checks, our CLA action will prompt you to accept the agreement. Head over to https://cla.vmware.com/ to see your current agreement(s) on file or to sign a new one.
24-
25-
We generally only need you (or your employer) to sign our CLA once and once signed, you should be able to submit contributions to any VMware project.
26-
27-
Note: if you would like to submit an "_obvious fix_" for something like a typo, formatting issue or spelling mistake, you may not need to sign the CLA.
1+
https://carvel.dev/shared/docs/latest/contributing/

SECURITY.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
## Vulnerability Disclosure
2-
3-
If you believe you have found a security issue in `kapp`, please privately and responsibly disclose it by following the directions in our [security policy](https://carvel.dev/shared/docs/latest/security-policy/).
1+
https://carvel.dev/shared/docs/latest/security-policy/

0 commit comments

Comments
 (0)