Skip to content

Commit 7a3740b

Browse files
fproulx-boostsecurityfproulx-boostsecurity
authored
Add OSSF Scorecard + Best Practices badges (#33)
* Add OSSF Scorecard + Best Practices badges We've made some changes to bring our Scorecard score to something good, but won't be able to reach 9.0 before 90 days of existence anyway. Best Practices will need a few more things, so I'm trying to squash a few here at the same time Signed-off-by: François Proulx <[email protected]> * Create CODE_OF_CONDUCT.md Signed-off-by: François Proulx <[email protected]> * Create MAINTAINERS.md Signed-off-by: François Proulx <[email protected]> * Create CONTRIBUTING.md Signed-off-by: François Proulx <[email protected]> --------- Signed-off-by: François Proulx <[email protected]>
1 parent efc8749 commit 7a3740b

File tree

4 files changed

+177
-0
lines changed

4 files changed

+177
-0
lines changed

‎CODE_OF_CONDUCT.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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, religion, or sexual identity
10+
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
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of 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
35+
address, 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 e-mail 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+
[email protected].
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
86+
of 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
93+
permanent 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
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing to Poutine
2+
3+
Thank you for your interest in contributing to `poutine`! We value the contributions of our community members and look forward to your input.
4+
5+
## Code of Conduct
6+
7+
Before you start contributing, please make sure to read and abide by our [Code of Conduct](./CODE_OF_CONDUCT.md). Additionally, we follow the Linux Foundation's guidelines for commit sign-offs. Please sign off your commits using the `-s` or `--signoff` flag.
8+
9+
## Getting Started
10+
11+
### Environment Setup
12+
13+
To contribute to Poutine, you'll need the following:
14+
15+
- [Go toolchain v1.22](https://golang.org/dl/) or higher.
16+
17+
### Contributing Process
18+
19+
1. **Find an Issue or Feature**: Check our [Roadmap](https://github.com/orgs/boostsecurityio/projects/2) or open [GitHub Issues](https://github.com/boostsecurityio/poutine/issues). Pick an existing issue or propose your feature request there.
20+
21+
2. **Get Approval**: For new features, wait for the issue to be labeled `Approved` by the maintainers.
22+
23+
3. **Fork and Code**: Fork the repository, make your changes, and ensure your code adheres to the provided coding conventions and quality standards.
24+
25+
4. **Submit a Pull Request (PR)**: Once you've completed your changes, submit a PR. Make sure your PR title and description clearly describe the changes. Include the issue number your PR addresses.
26+
27+
### Testing and Linting
28+
29+
- Run `gofmt` to ensure your code is properly formatted.
30+
- Include any tests relevant to the bug or feature you are addressing.
31+
32+
### Documentation
33+
34+
- Update the `README.md` if you introduce or modify any commands.
35+
- If your changes involve adding or altering rules, update the corresponding markdown file in `docs/content/en/rules/[RULE_ID].md`.
36+
37+
## Community and Questions
38+
39+
Currently, we handle all communications through GitHub issues and pull requests. If you have questions or need help with the setup, please open an issue and tag it as a question.

‎MAINTAINERS.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Maintainers
2+
3+
## `poutine-maintainers`
4+
5+
In alphabetical order:
6+
- Alexis-Maurer Fortin ([@SUSTAPLE117](https://github.com/SUSTAPLE117)), BoostSecurity.io
7+
- Benoit Côté-Jodoin ([@becojo](https://github.com/becojo)), BoostSecurity.io
8+
- François Proulx ([@fproulx-boostsecurity](https://github.com/fproulx-boostsecurity)), BoostSecurity.io

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8787/badge)](https://www.bestpractices.dev/projects/8787)
2+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/boostsecurityio/poutine/badge)](https://securityscorecards.dev/viewer/?uri=github.com/boostsecurityio/poutine)
13
![build](https://github.com/boostsecurityio/poutine/actions/workflows/build_test.yml/badge.svg)
24
![CodeQL](https://github.com/boostsecurityio/poutine/actions/workflows/codeql.yml/badge.svg)
35
[![Go Reference](https://pkg.go.dev/badge/github.com/boostsecurityio/poutine/v4.svg)](https://pkg.go.dev/github.com/boostsecurityio/poutine)

0 commit comments

Comments
 (0)