Labels and Usage
A maintainer may set labels on issues and pull requests to simplify handling. If someone does not agree with assigned labels give a comment and/or bring up the topic on a VSS meeting.
Most could also be used for pull requests
- question - Intended both for question that can be "easily" answered ("How do I do ...") but also for questions that require a discussion in a VSS Meeting ("Why do VSS ..."
- bug - Something in VSS (or VSS-tools) that needs to be fixed
- enhancement - Idea on enhancement or improvement.
For Pull Requests and Issues - indicates how the PR or issue shall be handled.
- Strategic - a change that significantly would change scope/meaning/technology of project. Shall be discussed in VSS project meetings. If meeting is in favor of the idea the Data Expert Group shall be involved - they may in turn consult or escalate to board, or decide that the change must be discussed at an AMM. Only after approval by Data Expert Group the change may be merged. From this point handled as a major change, but timeplan for release must be clearly communicated.
- Major - a change that either significantly adds new functionality, or affects backward compatibility. May only be released as part of major release. A maintainer shall acknowledge the reception of the PR in a comment and ask for comments. The PR shall be announced in VSS meetings and on other channels like Slack. If no-one objects within 2 weeks after the PR has been announced at a VSS meeting a decision may be taken at a VSS meeting to merge the change. If there are objections there shall be a formal vote.
- Minor - A change that is not major and not trivial. May be released as part of a minor release. From a process perspective handled as major.
- Trivial - Spelling fixes, submodule update, trivial bug-fixes, and similar. A maintainer may merge the change directly if the maintainer does not have any objections and CI pass without problems. The maintainer may ask someone else to review or test the change, but it is not mandatory.
- Blocker - To be used for critical bug fixes. A maintainer may merge the change directly if the maintainer does not have any objections and CI pass without problems. The fix shall be discussed at next VSS meeting where it shall be decided if a new release is required.
Additional labels that might be used to indicate handling of ticket
- New - An issue/PR that not yet have been discussed/announced at a VSS meeting
- Review - An issue/PR in active review/discussion, prioritized for upcoming meetings, may be merged soon if no-one obhect
- Approved - Approved for merge
- Rejected - PR/issue rejected, will not be merged, will be closed soon if no-one objects
- Rework - committer must refactor or address comments
- Waiting - Additional input from other body (TST, Board, Open Source Officer, Member company, ..) needed before a decision can be taken
- WorkInProgress - Someone is actively working on changing/extending this PR
- NoProgress - No progress in the last 3 months, candidate for closing
- Wontfix - Used as proposal from maintainer, or to indicate VSS meeting decision. If a maintainer suggests "wontfix" there shall be a comment explaining why and the maintainer shall wait at least 2 weeks before closing the issue to give time for objections, unless "wontfix" is decided at a VSS meeting in which case the ticket can be directly closed.
- DoNotMerge - Used in addition to other labels. The content of this PR may be review/approved, but should not be merged, at least not now for some reason. It could be that it is intended first for a later release, or that changes in some other repository is needed
- Duplicate - Used by maintainer to indicate that a ticket completely overlaps with an existing ticket. If a maintainer suggests "duplicate" there shall be a comment explaining why and the maintainer shall wait at least 2 weeks before closing the issue to give time for objections, unless "duplicate" is decided at a VSS meeting in which case the ticket can be directly closed.
