docs(contributing): add additional step in the feature flags section#21074
docs(contributing): add additional step in the feature flags section#21074mergify[bot] merged 3 commits intoaws:mainfrom
Conversation
|
|
| through `cdk init`. | ||
| 4. In your tests, use the `testFutureBehavior` and `testLegacyBehavior` [jest helper methods] to test the enabled and disabled behavior. | ||
| 5. In your PR title (which goes into CHANGELOG), add a `(under feature flag)` suffix. e.g: | ||
| 4. Add an entry for your feature flag in the [README](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/cx-api/README.md) file. |
There was a problem hiding this comment.
cc @TheRealAmazonKendra. I've started adding things here for the time being, but not sure what you think.
There was a problem hiding this comment.
No objections.
CONTRIBUTING.md
Outdated
| 4. In your tests, use the `testFutureBehavior` and `testLegacyBehavior` [jest helper methods] to test the enabled and disabled behavior. | ||
| 5. In your PR title (which goes into CHANGELOG), add a `(under feature flag)` suffix. e.g: | ||
| 4. Add an entry for your feature flag in the [README](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/cx-api/README.md) file. | ||
| 5. In your tests, use the `testFutureBehavior` and `testLegacyBehavior` [jest helper methods] to test the enabled and disabled behavior. |
There was a problem hiding this comment.
So, now that we're on v2, these tests no longer work the way we expect them to. I realize your change isn't to this line, except to update the numbering, but could you edit this line to just say to test with and without the feature flags enabled?
There was a problem hiding this comment.
Yes, of course! Thanks for the hint. I struggled with this as well when I implemented a feature flag.
There was a problem hiding this comment.
I'm working on a rewrite for feature flags and the testing utilities but I don't yet have the design proposal done so it's going to be a minute. In the meantime I don't want to keep misleading people. Thanks for making this change for us!
There was a problem hiding this comment.
I was very pleased to do that. :)
|
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 CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
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). |
Follow-Up to this Comment.
In the contributing documentation for the feature flags the part for adding an entry in the feature flags README was added in this PR.
All Submissions:
Adding new Unconventional Dependencies:
New Features
yarn integto deploy the infrastructure and generate the snapshot (i.e.yarn integwithout--dry-run)?By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license