Skip to content

Conversation

@scottrigby
Copy link
Member

No description provided.

Signed-off-by: Scott Rigby <scott@r6by.com>
34. `in progress` → GitHub draft PR status handles this
35. `keep open` → automation can handle this
36. `needs-pick` → release automation handles this
37. `oci` → use title prefixes instead

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't more a "scope" ? Like feat(oci): or bug(sdk):

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what I meant by title prefixes 👍

There is a convention some projects use like area/AREA - we have only one label following that syntax, area/helm-test. But other labels like oci could perhaps follow this. At the moment I lean toward just using prefixing in the PR title like you said.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe going with conventional commits language could be good, eg using scope/oci, scope/docs etc. I'm on the fence about this because often a PR touches more than one of these kinds of areas/scopes, and it seems to be a judgement call about whether to add this and if so what scope should be.

Copy link
Contributor

@banjoh banjoh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the intention to rely on Conventional Commits as well when automating processes such as generating release notes?


### Conventional Commits Integration

#### Required PR Title Format
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm finding this list quite long to remember. When someone is making a PR, they'll tend to choose from a few of these, meaning that some will never be used.

Comment on lines +49 to +50
- `build: description` for build system changes
- `ci: description` for CI/CD changes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would bundle ci and build into one. Maybe ci. For changes related to building locally

### Policy Implementation

#### Triage Phase
- Triager or core maintainers update PR title to follow Conventional Commits format
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not fail the build and expect the author to add the necessary categorisation. I'm leaning towards just using labels and not relying on conventional commits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants