Skip to content

Commit fc67150

Browse files
docs: add missing base documentation (#349)
This adds a CONTRIBUTING.md and CODE_OF_CONDUCT.md to address deficiencies and assist with progressing OSV Schema TI Graduation Application (ossf/tac#456) For want of something better, I used what is present at https://github.com/ossf/oss-vulnerability-guide Signed-off-by: Andrew Pollock <[email protected]> Signed-off-by: Andrew Pollock <[email protected]>
1 parent e540247 commit fc67150

File tree

2 files changed

+101
-0
lines changed

2 files changed

+101
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery and unwelcome sexual attention or
22+
advances
23+
- Trolling, insulting/derogatory comments, and personal or political attacks
24+
- Public or private harassment
25+
- Publishing others' private information, such as a physical or electronic
26+
address, without explicit permission
27+
- Other conduct which could reasonably be considered inappropriate in a
28+
professional setting
29+
30+
## Enforcement Responsibilities
31+
32+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33+
34+
Project maintainers have the right and responsibility to remove, edit, or reject
35+
comments, commits, code, wiki edits, issues, and other contributions that are
36+
not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
37+
38+
## Scope
39+
40+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
41+
42+
## Enforcement
43+
44+
### Enforcement Guidelines
45+
46+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
47+
48+
1. Correction
49+
50+
**Community Impact:** Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
51+
52+
**Consequence:** A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
53+
54+
2. Warning
55+
56+
**Community Impact:** A violation through a single incident or series of actions.
57+
58+
**Consequence:** A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
59+
60+
3. Temporary Ban
61+
62+
**Community Impact:** A serious violation of community standards, including sustained inappropriate behavior.
63+
64+
**Consequence:** A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
65+
66+
4. Permanent Ban
67+
68+
**Community Impact:** Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
69+
70+
**Consequence:** A permanent ban from any sort of public interaction within the community.
71+
72+
## Attribution
73+
74+
This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at <https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
75+
76+
Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder.](https://github.com/mozilla/inclusion)
77+
78+
For answers to common questions about this code of conduct, see the FAQ at <https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.

CONTRIBUTING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# How to Contribute
2+
3+
We'd love to accept your patches and contributions to this project. There are
4+
just a few small guidelines you need to follow.
5+
6+
## Code of Conduct
7+
8+
This is a project of the [Open Source Security Foundation](https://github.com/ossf/) and follows its [Code of Conduct](CODE_OF_CONDUCT.md).
9+
10+
## Accepted Contributions
11+
12+
This repository is primarily for the OSV Schema definition((human-readable)[docs/schema.md] and [JSON Schema](validation/schema.json)), and related tooling.
13+
14+
See the [guiding principles](GUIDING_PRINCIPLES.md) for background thinking behind the schema's design, and what is more and less likely to be acceptable in the way of changes.
15+
16+
For more substantial changes, we encourage you to open an issue for discussion and to also engage with the [OpenSSF Vulnerability Working Group](https://github.com/ossf/wg-vulnerability-disclosures/) about the proposed change.
17+
18+
## Code Reviews
19+
20+
All submissions, including submissions by project members, require review. We
21+
use GitHub pull requests for this purpose. Consult
22+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
23+
information on using pull requests.

0 commit comments

Comments
 (0)