Skip to content

Commit d88bcf7

Browse files
idunbarhidunbarh
committed
docs: adding CONTRIBUTING.md and other common project files
Signed-off-by: Ian Dunbar-Hall <ian.dunbar-hall@lmco.com>
1 parent d2f67b9 commit d88bcf7

File tree

6 files changed

+233
-0
lines changed

6 files changed

+233
-0
lines changed

‎CODEOWNERS

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# bomctl maintainers will be the default owners for everything in the repo
2+
3+
* @bomctl/maintainers

‎CODE_OF_CONDUCT.md

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

‎CONTRIBUTING.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contributing to homebrew-bomctl
2+
3+
We're excited you're interested in contributing to the bomctl project! This document outlines the guidelines for contributing code, documentation, and other improvements to the project.
4+
5+
The bomctl project is under the Open Source Security Foundation (OpenSSF) Security Tooling Working Group, a collaborative effort to improve the security of open source software. We value contributions from everyone and strive to create a welcoming and inclusive community.
6+
7+
## Getting Started
8+
9+
Before diving in, here are a few things to keep in mind:
10+
11+
### License
12+
13+
The bomctl project is licensed under the [Apache 2.0 license](LICENSE). By contributing, you agree to abide by the terms of this license. You can find the license file in the repository root directory.
14+
15+
### Code of Conduct
16+
17+
We have a Code of Conduct that outlines the expectations for respectful and professional behavior in our community. Please review the [Code of Conduct](CODE_OF_CONDUCT.md) before contributing
18+
19+
## Ways to Contribute
20+
21+
There are many ways to contribute to the bomctl project:
22+
23+
* __Code__: Submit pull requests (PRs) for bug fixes, new features, or improvements to existing code.
24+
* __Documentation__: Help improve the project's documentation by fixing typos, clarifying concepts, or adding new content.
25+
* __Testing__: Write unit tests or integration tests to improve the project's code coverage and stability.
26+
* __Reporting Issues__: If you find a bug or have a suggestion for improvement, report it as an issue on the project's GitHub repository.
27+
28+
## Steps to Contribute
29+
30+
Here's a step-by-step guide for making a contribution:
31+
32+
1. __Identify Issue__: Find an existing issue you want to work or submit a new issue describing your proposed change.
33+
1. __Claim Issue__: Assign yourself to the issue if possible, or leave a comment on the issue stating your intent to work it.
34+
1. __Fork the Repository__: Fork the bomctl repository on GitHub to your own account. This allows you to make changes to the codebase without affecting the original project.
35+
1. __Clone the Fork__: Clone your forked repository to your local machine.
36+
1. __Create a Branch__: Create a new branch for your changes. Use a descriptive branch name that reflects the nature of your contribution.
37+
1. __Make Changes__: Make your changes to the codebase and write unit tests for any new features you introduce.
38+
1. __Commit Changes__: Commit your changes with clear and concise commit messages following the [conventional commit format](https://www.conventionalcommits.org/).
39+
* Your [commits must be signed](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits) with a key associated with your GitHub account.
40+
1. __Push Changes__: Push your changes to your forked repository on GitHub.
41+
1. __Open a Pull Request__: Open a pull request from your branch to the main branch of the upstream repository.
42+
* Your PR title should follow the [conventional commit format](https://www.conventionalcommits.org/).
43+
1. __Address Reviews__: Respond to any feedback or requests for changes from the project maintainers.
44+
45+
## Tips for Writing Pull Requests
46+
47+
* Keep your pull requests focused on a single issue or feature.
48+
* Ensure your code adheres to the project's coding style guidelines.
49+
* Write clear and concise commit messages following the [convention commit format](https://www.conventionalcommits.org/) that describe the changes you made.
50+
* Be patient and responsive to feedback from the project maintainers.
51+
52+
## Additional Resources
53+
54+
Here are some additional resources that you may find helpful:
55+
56+
* __GitHub Pull Requests__: <https://docs.github.com/en/pull-requests>
57+
* __Git Basics__: <https://git-scm.com/>
58+
* __Contributing to Open Source__: <https://www.freecodecamp.org/news/how-to-make-your-first-open-source-contribution/>
59+
60+
We appreciate your contributions to the bomctl project! If you have any questions, feel free to reach out to the project maintainers or open an issue on the project's GitHub repository.

‎COPYRIGHT.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Copyright 2024 The bomctl a Series of LF Projects, LLC.
2+
3+
Licensed under the Apache License, Version 2.0 (the "License");
4+
you may not use this file except in compliance with the License.
5+
You may obtain a copy of the License at <http://www.apache.org/licenses/LICENSE-2.0>.
6+
7+
Unless required by applicable law or agreed to in writing, software
8+
distributed under the License is distributed on an "AS IS" BASIS,
9+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10+
See the License for the specific language governing permissions and
11+
limitations under the License.

‎MAINTAINERS.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Maintainers
2+
3+
The __maintainers__ listed below actively maintain this project. If a contributor has questions please
4+
reach out using issues or the #bomctl channel on OpenSSF Slack. If you have other questions about this
5+
project, please see the following documents.
6+
7+
* See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) we expect all members of this project's community to follow.
8+
* See [CONTRIBUTING.md](CONTRIBUTING.md) for general contribution guidelines.
9+
10+
Maintainers (in alphabetical order)
11+
12+
* @ashearin
13+
* @eddiezane
14+
* @idunbarh
15+
* @jhoward-lm
16+
* @pkwiatkowski1
17+
18+
Emeritus Maintainers (in alphabetical order)
19+
20+
* None

‎SECURITY.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Reporting Security Issues
2+
3+
The bomctl team and community take security bugs in `bomctl` seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
4+
5+
To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/bomctl/bomctl/security/advisories/new) tab.
6+
7+
The bomctl team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.

0 commit comments

Comments
 (0)