You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+31
Original file line number
Diff line number
Diff line change
@@ -39,6 +39,37 @@ To send us a pull request, please:
39
39
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40
40
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
41
41
42
+
### Changelog Documents
43
+
44
+
(You can SKIP this step if you are only changing the code generator, and not the runtime).
45
+
46
+
When submitting a pull request please include a changelog file on a folder named `.changelog`.
47
+
These are used to generate the content `CHANGELOG.md` and Release Notes. The format of the file is as follows:
48
+
49
+
```
50
+
{
51
+
"id": "12345678-1234-1234-1234-123456789012"
52
+
"type": "bugfix"
53
+
"collapse": true
54
+
"description": "Fix improper use of printf-style functions.",
55
+
"modules": [
56
+
"."
57
+
]
58
+
}
59
+
```
60
+
61
+
* id: a UUID. This should also be used for the name of the file, so if your id is `12345678-1234-1234-1234-123456789012` the file should be named `12345678-1234-1234-1234-123456789012.json/`
62
+
* type: one of the following:
63
+
* bugfix: Fixing an existing bug
64
+
* Feature: Adding a new feature to an existing service
65
+
* Release: Releasing a new module
66
+
* Dependency: Updating dependencies
67
+
* Announcement: Making an announcement, like deprecation of a module
68
+
* collapse: whether this change should appear separately on the release notes on every module listed on `modules` (`"collapse": false`), or if it should show up as a single entry (`"collapse": true`)
69
+
* For the smithy-go repository this should always be `false`
70
+
* description: Description of this change. Most of the times is the same as the title of the PR
71
+
* modules: which Go modules does this change impact. The root module is expressed as "."
72
+
42
73
43
74
## Finding contributions to work on
44
75
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
Copy file name to clipboardexpand all lines: codegen/smithy-go-codegen/src/main/java/software/amazon/smithy/go/codegen/GoJmespathExpressionGenerator.java
Copy file name to clipboardexpand all lines: codegen/smithy-go-codegen/src/test/java/software/amazon/smithy/go/codegen/GoJmespathExpressionGeneratorTest.java
+32-16
Original file line number
Diff line number
Diff line change
@@ -124,7 +124,11 @@ public void testSubexpression() {
0 commit comments