Skip to content

docs: clarify commit prefixes#20910

Merged
mergify[bot] merged 3 commits intomainfrom
huijbers/clarify-conventional-commits
Jul 4, 2022
Merged

docs: clarify commit prefixes#20910
mergify[bot] merged 3 commits intomainfrom
huijbers/clarify-conventional-commits

Conversation

@rix0rrr
Copy link
Copy Markdown
Contributor

@rix0rrr rix0rrr commented Jun 29, 2022


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@rix0rrr rix0rrr requested a review from a team June 29, 2022 08:40
@rix0rrr rix0rrr self-assigned this Jun 29, 2022
@gitpod-io
Copy link
Copy Markdown

gitpod-io bot commented Jun 29, 2022

@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jun 29, 2022
@aws-cdk-automation aws-cdk-automation requested a review from a team June 29, 2022 08:40
@github-actions github-actions bot added the p2 label Jun 29, 2022
* `fix`: indicates a bug fixes (requires tests)
* `docs`: indicates updated documentation (docstrings or Markdown files)
* `refactor`: indicates a feature-preserving refactoring
* `chore`: something without directly visible user benefit (does not end up in the CHANGELOG). Typically used for build scripts, config, or changes so minor they don't warrant showing up the CHANGELOG.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
* `chore`: something without directly visible user benefit (does not end up in the CHANGELOG). Typically used for build scripts, config, or changes so minor they don't warrant showing up the CHANGELOG.
* `chore`: something without directly visible user benefit (does not end up in the CHANGELOG). Typically used for build scripts or config changes.

I think "minor" changes leaves too much open to interpretation. I think if there is any functionality change, no matter how "minor", it should not be a chore.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure. New enum members for example, or a property that should always have been there but wasn't. I mean I guess technically they are features, but it feels a little like scraping the bottom of the barrel to me to put that up in the CHANGELOG. As in, I would feel ashamed putting it there 🫣

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Properties that should have been there like these? I feel like it's better to default to being less ambiguous. Core members can always change it to chore before approving if they really don't want it to show up in the CHANGELOG.

// Fields not yet implemented:
// ==========================
// https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-capacityreservationspecification.html
// Will require creating an L2 for AWS::EC2::CapacityReservation
// capacityReservationSpecification: undefined,
// https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata-cpuoptions.html
// cpuOptions: undefined,
// https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-elasticgpuspecification.html
// elasticGpuSpecifications: undefined,
// https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-elasticinferenceaccelerators
// elasticInferenceAccelerators: undefined,
// https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-kernelid
// kernelId: undefined,
// ramDiskId: undefined,
// https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-licensespecifications
// Also not implemented in Instance L2
// licenseSpecifications: undefined,
// https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-metadataoptions
// metadataOptions: undefined,
// https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-launchtemplate-launchtemplatedata.html#cfn-ec2-launchtemplate-launchtemplatedata-tagspecifications
// Should be implemented via the Tagging aspect in CDK core. Complication will be that this tagging interface is very unique to LaunchTemplates.
// tagSpecification: undefined
// CDK has no abstraction for Network Interfaces yet.
// networkInterfaces: undefined,
// CDK has no abstraction for Placement yet.
// placement: undefined,

But if you think we should be using chore more for minor changes then I guess I'm fine with that.

CONTRIBUTING.md Outdated
[conventionalcommits](https://www.conventionalcommits.org).
* The title must begin with `feat(module): title`, `fix(module): title`, `refactor(module): title` or
`chore(module): title`.
* `feat`: indicates a feature added (requires tests and README updates)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we also mention that these requirements are not hard requirements and CDK maintainers have the ability to override via labels if they see fit.

I agree that people are using chore when they should be using fear to skirt these requirements, it would help to know that there are overrides in place.

@corymhall corymhall added the pr/do-not-merge This PR should not be merged at this time. label Jul 1, 2022
@rix0rrr rix0rrr removed the pr/do-not-merge This PR should not be merged at this time. label Jul 4, 2022
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Jul 4, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Copy Markdown
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 9c19e0a
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@mergify mergify bot merged commit 4a5deec into main Jul 4, 2022
@mergify mergify bot deleted the huijbers/clarify-conventional-commits branch July 4, 2022 14:34
@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented Jul 4, 2022

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

daschaa pushed a commit to daschaa/aws-cdk that referenced this pull request Jul 9, 2022
----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution/core This is a PR that came from AWS. p2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants