Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Review and update CONTRIBUTING.md #4002

Merged
merged 10 commits into from
Apr 4, 2024
Merged

📖 Review and update CONTRIBUTING.md #4002

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
99c0e36
feature dco requirement more prominently
spencerschrock Apr 3, 2024
b123cbd
recommend merge commits to sync PR
spencerschrock Apr 3, 2024
0ad51cd
fix make target table
spencerschrock Apr 3, 2024
12867ac
remove references to old Go environment variables
spencerschrock Apr 3, 2024
be7a687
misc minor clarifications
spencerschrock Apr 3, 2024
5a2dc9e
remove reference to errors from CONTRIBUTORS.md
spencerschrock Apr 3, 2024
b792ee1
mention make in environment
spencerschrock Apr 4, 2024
e888c13
no scopes needed for PATs
spencerschrock Apr 4, 2024
deacac2
highlight other scorecard options
spencerschrock Apr 4, 2024
0dca25e
allow shell codeblocks to be pasted into a shell
spencerschrock Apr 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
feature dco requirement more prominently 
Signed-off-by: Spencer Schrock <sschrock@google.com>
  • Loading branch information
@spencerschrock
spencerschrock committed Apr 3, 2024
commit 99c0e360a5a4431afe145cdce3142f5f9840c1ff
13 changes: 8 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,15 @@
Thank you for contributing your time and expertise to the OpenSSF Scorecard
project. This document describes the contribution guidelines for the project.

**Note:** Before you start contributing, you must read and abide by our
> [!IMPORTANT]
> Before you start contributing, you must read and abide by our
**[Code of Conduct](./CODE_OF_CONDUCT.md)**.
>
> Additionally the Linux Foundation (LF) requires all contributions include per-commit sign-offs.
> Ensure you use the `-s` or `--signoff` flag for every commit.
>
> For more details, see the [LF DCO wiki](https://wiki.linuxfoundation.org/dco)
> or [this Pi-hole signoff guide](https://docs.pi-hole.net/guides/github/how-to-signoff/).

<!-- vim-markdown-toc GFM -->

Expand Down Expand Up @@ -141,10 +148,6 @@ Following the targets that can be used to test your changes locally.
| make all | Runs go test,golangci lint checks, fmt, go mod tidy| yes |
| make e2e-pat | Runs e2e tests | yes |

Make sure to signoff your commits before submitting a pull request.

https://docs.pi-hole.net/guides/github/how-to-signoff/

When developing locally, the following commands are useful to run regularly to check unit tests and linting.

| Command | Description | Is called in the CI? |
Expand Down