Skip to content

Commit

Permalink
impl: Create new project lifecycle process
Browse files Browse the repository at this point in the history
As discussed in the 2023-10-09 specification meeting, create a new
"Project lifecycle" for major projects (new version, new track, etc).
The main idea is to assign a "project shepherd" to oversee the project.
This person is responsible for moving the project along. The reason for
creating this is that many projects seem to stagnate without a single
responsible person.

This commit populates the initial list of projects as per our discussion
at the meeting.

Signed-off-by: Mark Lodato <lodato@google.com>
  • Loading branch information
MarkLodato committed Oct 10, 2023
1 parent 2180a00 commit 734fd29
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 4 deletions.
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) |
| [Build Platform Operations Track] | Marcela Melera (@marcelamelera), Chad Kimes (@chkimes) |
| [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
[Build Platform Operations Track]: 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

0 comments on commit 734fd29

Please sign in to comment.