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

Update CONTRIBUTING.md regarding YEAR/ directory #832

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update CONTRIBUTING.md regarding YEAR/ directory #832

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 14 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
# Contributing to the SPDX Meeting Repository

## General

Each team maintains their own minutes directory.

If a team has conventions different from the conventions documented in this file, they should include a CONTRIBUTING.md file at the top level of their directory.

## File Naming Conventions
Meeting minutes are titled by the date in the format `YYYY-MM-DD.md`.
At the end of the year, that year's files should be moved into a directory named for that year `YYYY`.

For meeting minutes organization and sorting purpose:

- Meeting minutes should be titled using the date in the format `YYYY-MM-DD.md`.
- Meeting minutes should be stored in a directory named for the year `YYYY`.
- Additional files relevant to a meeting minutes `YYYY-MM-DD.md` should be
named as `YYYY-MM-DD-relevant-file-label.md` (e.g., `2024-12-24-diagram.md`),
and stored in the same `YYYY` directory.

## Pull Requests

New meeting minutes should be added as a pull request.
Sufficient time should be allowed for review before merging.
It is suggested that there is at least one review from an attendee of the meeting, but even if no reviews, it should be merged before the next meeting.