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.

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

impl: Create new project lifecycle process #981

Merged
merged 4 commits into from
Oct 16, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,3 +210,46 @@ You can automatically append a sign-off to a commit by passing the `-s` /

**Note**: this requires your `user.name` and `user.email` are set correctly
in your git config.

## Project lifecycle

Major projects that require considerable effort, such as a new release, a new
track, or a new level, should have a top-level GitHub issue and a shepherd to
oversee the project and move it along. Without a shepherd, a project is likely
to stagnate. If you would like to be a shepherd for a project, just nominate
yourself in the issue.

Responsibilities of the shepherd:

- Maintaining the top-level GitHub issue to track the overall project
- Breaking down the project into tasks
- Pinging open issues and pull requests when stale
- Getting consensus among Contributors and Maintainers
- Suggesting priorities
- Providing regular updates to the community
- Adding a project entry in [README.md](README.md)

Template for GitHub issue:

- Title: `Project: <name>`
- Assignee: \<shepherd\>
- Labels: [`project`](https://github.com/slsa-framework/slsa/labels/project)
- Description:

```markdown
This is a tracking issue for [SHORT DESCRIPTION].

[Project shepherd]: YOUR NAME (@GITHUB_USERNAME)

Sub-issues:

- [ ] #1234
- [ ] #4568

[Project shepherd]: https://github.com/slsa-framework/slsa/blob/main/CONTRIBUTING.md#project-lifecycle

---

[any other text]

```
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,25 @@ specification, and overall project management. Other git repositories within the
[slsa-framework](https://github.com/slsa-framework) organization have
repo-specific issue trackers.

## How to get involved

See https://slsa.dev/community for ways to get involved in SLSA development.

## Active projects

| Project | [Shepherd] |
| ------- | ---------- |
| [Build Level 4] | David A Wheeler (@david-a-wheeler) |
| [Hardware Attested Builds] | Marcela Melara (@marcelamelara), Chad Kimes (@chkimes) |
MarkLodato marked this conversation as resolved.
Show resolved Hide resolved
| [Source Track] | Kris K (@kpk47) |
| [Version 1.1 release] | Joshua Lock (@joshuagl) |

[Shepherd]: CONTRIBUTING.md#project-lifecycle
[Build Level 4]: https://github.com/slsa-framework/slsa/issues/977
[Hardware Attested Builds]: https://github.com/slsa-framework/slsa/issues/975
[Source Track]: https://github.com/slsa-framework/slsa/issues/956
[Version 1.1 release]: https://github.com/slsa-framework/slsa/issues/900

## URL Aliases

We have several [redirect](docs/_redirects) configured on slsa.dev for
Expand All @@ -35,10 +54,6 @@ convenience of the team:
(or [.../spec](https://slsa.dev/notes/spec))
- https://slsa.dev/notes/tooling

## How to get involved

See https://slsa.dev/community for ways to get involved in SLSA development.

## Governance

SLSA is an [OpenSSF](https://openssf.org) project. See
Expand Down