Skip to content

Commit 1038826

Browse files
authored
Add governance docs (#97)
* Add CoC, DCO, and contributing guides Signed-off-by: Dan Barr <[email protected]> * Add security policy Signed-off-by: Dan Barr <[email protected]> --------- Signed-off-by: Dan Barr <[email protected]> Signed-off-by: Dan Barr <[email protected]> Co-authored-by: Dan Barr <[email protected]>
1 parent 9619b65 commit 1038826

File tree

4 files changed

+286
-0
lines changed

4 files changed

+286
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# 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, nationality, personal appearance, race, religion, or sexual identity
10+
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+
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
62+
incident. Further details of specific enforcement policies may be posted
63+
separately.
64+
65+
Project maintainers who do not follow or enforce the Code of Conduct in good
66+
faith may face temporary or permanent repercussions as determined by other
67+
members of the project's leadership.
68+
69+
## Attribution
70+
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
72+
version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
73+
74+
[homepage]: http://contributor-covenant.org
75+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Contributing to Stacklok Docs <!-- omit from toc -->
2+
3+
First off, thank you for taking the time to contribute to the Stacklok
4+
documentation! :+1: :tada: This project is released under the Apache 2.0
5+
license. If you would like to contribute something or want to hack on the code,
6+
this document should help you get started. You can find some hints for starting
7+
development in the [README](README.md).
8+
9+
## Table of contents <!-- omit from toc -->
10+
11+
- [Code of conduct](#code-of-conduct)
12+
- [Reporting security vulnerabilities](#reporting-security-vulnerabilities)
13+
- [How to contribute](#how-to-contribute)
14+
- [Docs framework and style](#docs-framework-and-style)
15+
- [Using GitHub Issues](#using-github-issues)
16+
- [Pull request process](#pull-request-process)
17+
- [Commit message guidelines](#commit-message-guidelines)
18+
19+
## Code of conduct
20+
21+
This project adheres to the [Contributor Covenant](CODE_OF_CONDUCT.md) code of
22+
conduct. By participating, you are expected to uphold this code. Please report
23+
unacceptable behavior to
24+
25+
26+
## Reporting security vulnerabilities
27+
28+
If you think you have found a security vulnerability in the Stacklok Docs
29+
website, please DO NOT disclose it publicly until we've had a chance to fix it.
30+
Please don't report security vulnerabilities using GitHub issues; instead,
31+
please follow this [process](SECURITY.md).
32+
33+
## How to contribute
34+
35+
### Docs framework and style
36+
37+
Please review the [README](README.md) and [STYLE-GUIDE](STYLE-GUIDE.md) for more
38+
information about how to contribute to the documentation.
39+
40+
### Using GitHub Issues
41+
42+
We use GitHub issues to track bugs and enhancements. If you have a general usage
43+
question, please ask in
44+
[Stacklok's community Discord](https://discord.gg/stacklok).
45+
46+
If you are reporting a bug, please help to speed up problem diagnosis by
47+
providing as much information as possible. Ideally, that would include a small
48+
sample project that reproduces the problem.
49+
50+
### Pull request process
51+
52+
- -All commits must include a Signed-off-by trailer at the end of each commit
53+
message to indicate that the contributor agrees to the Developer Certificate
54+
of Origin. For additional details, check out the [DCO instructions](DCO.md).
55+
- Create an issue outlining the fix or feature.
56+
- Fork the repository to your own GitHub account and clone it locally.
57+
- Hack on your changes.
58+
- Correctly format your commit messages, see
59+
[Commit message guidelines](#commit-message-guidelines) below.
60+
- Open a PR by ensuring the title and its description reflect the content of the
61+
PR.
62+
- Ensure that CI passes, if it fails, fix the failures.
63+
- Every pull request requires a review from the Stacklok team before merging.
64+
- Once approved, all of your commits will be squashed into a single commit with
65+
your PR title.
66+
67+
### Commit message guidelines
68+
69+
We follow the commit formatting recommendations found on
70+
[Chris Beams' How to Write a Git Commit Message article](https://chris.beams.io/posts/git-commit/):
71+
72+
1. Separate subject from body with a blank line
73+
1. Limit the subject line to 50 characters
74+
1. Capitalize the subject line
75+
1. Do not end the subject line with a period
76+
1. Use the imperative mood in the subject line
77+
1. Use the body to explain what and why vs. how

DCO.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Developer Certificate of Origin (DCO)
2+
3+
In order to contribute to the project, you must agree to the Developer
4+
Certificate of Origin. A
5+
[Developer Certificate of Origin (DCO)](https://developercertificate.org/) is an
6+
affirmation that the developer contributing the proposed changes has the
7+
necessary rights to submit those changes. A DCO provides some additional legal
8+
protections while being relatively easy to do.
9+
10+
The entire DCO can be summarized as:
11+
12+
- Certify that the submitted code can be submitted under the open source license
13+
of the project (e.g. Apache 2.0)
14+
- I understand that what I am contributing is public and will be redistributed
15+
indefinitely
16+
17+
## How to Use Developer Certificate of Origin
18+
19+
In order to contribute to the project, you must agree to the Developer
20+
Certificate of Origin. To confirm that you agree, your commit message must
21+
include a Signed-off-by trailer at the bottom of the commit message.
22+
23+
For example, it might look like the following:
24+
25+
```bash
26+
A commit message
27+
28+
Closes gh-345
29+
30+
Signed-off-by: jane marmot <[email protected]>
31+
```
32+
33+
The Signed-off-by [trailer](https://git-scm.com/docs/git-interpret-trailers) can
34+
be added automatically by using the
35+
[-s or –signoff command line option](https://git-scm.com/docs/git-commit/2.13.7#Documentation/git-commit.txt--s)
36+
when specifying your commit message:
37+
38+
```bash
39+
git commit -s -m
40+
```
41+
42+
If you have chosen the
43+
[Keep my email address private](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#about-commit-email-addresses)
44+
option within GitHub, the Signed-off-by trailer might look something like:
45+
46+
```bash
47+
A commit message
48+
49+
Closes gh-345
50+
51+
Signed-off-by: jane marmot <[email protected]>
52+
```

SECURITY.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Security Policy
2+
3+
Stacklok takes security seriously! We appreciate your efforts to disclose your
4+
findings responsibly and will make every effort to acknowledge your
5+
contributions.
6+
7+
## Reporting a vulnerability
8+
9+
To report a security issue, please use the GitHub Security Advisory
10+
["Report a Vulnerability"](https://github.com/stacklok/docs-website/security/advisories/new)
11+
tab.
12+
13+
If you are unable to access GitHub you can also email us at
14+
15+
16+
When reporting a vulnerability, please include:
17+
18+
- Steps to reproduce the issue
19+
- Description of the potential impact
20+
- Any additional context that would help us understand the issue
21+
22+
If you are only comfortable sharing under GPG, please start by sending an email
23+
requesting a public PGP key to use for encryption.
24+
25+
### Contacting the Stacklok security team
26+
27+
Contact the team by sending email to
28+
29+
30+
## About this project
31+
32+
This repository contains a documentation website built with Docusaurus. Security
33+
vulnerabilities in this context are most likely to come from:
34+
35+
- Upstream dependencies (Node.js packages, Docusaurus framework)
36+
- Build and deployment pipeline issues
37+
- Content injection or cross-site scripting vulnerabilities
38+
- Infrastructure or hosting configuration issues
39+
40+
## Disclosure process
41+
42+
Stacklok follows a responsible disclosure model for handling security
43+
vulnerabilities.
44+
45+
### Private disclosure
46+
47+
We prefer that suspected vulnerabilities be reported privately to allow us time
48+
to investigate and address the issue before public disclosure.
49+
50+
### Public disclosure
51+
52+
If you become aware of a publicly disclosed security vulnerability that affects
53+
this documentation website, please email
54+
[[email protected]](mailto:[email protected]) immediately so we can
55+
assess the impact and take appropriate action.
56+
57+
## Response process
58+
59+
When a vulnerability is reported:
60+
61+
1. **Acknowledgment**: We will acknowledge receipt of your report within 2
62+
business days
63+
2. **Assessment**: Our security team will assess the vulnerability and determine
64+
its impact
65+
3. **Resolution**: We will work to address the issue, which may involve:
66+
- Updating dependencies
67+
- Modifying configuration
68+
- Coordinating with upstream projects
69+
- Implementing workarounds or mitigations
70+
4. **Communication**: We will keep you informed of our progress and notify the
71+
community as appropriate
72+
73+
For vulnerabilities in upstream dependencies, our response timeline may depend
74+
on fixes being available from the upstream maintainers.
75+
76+
## Community notification
77+
78+
Significant security updates will be communicated through:
79+
80+
- GitHub Security Advisories
81+
- Updates to this documentation
82+
- The [Stacklok Discord Server](https://discord.gg/stacklok)

0 commit comments

Comments
 (0)