-
Notifications
You must be signed in to change notification settings - Fork 55
chore: add gh issue and pr templates #164
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| --- | ||
| name: 🐛 Bug report | ||
| about: Something isn't working as expected 🤔. | ||
| labels: bug, needs-triage | ||
| --- | ||
|
|
||
| ## Describe the bug | ||
| <!--- A clear and concise description of what the bug is --> | ||
|
|
||
| ## Expected Behavior | ||
| <!--- Tell us what should happen --> | ||
|
|
||
| ## Current Behavior | ||
| <!--- Tell us what happens instead of the expected behavior --> | ||
|
|
||
| <!--- Include full errors, uncaught exceptions, stack traces, and relevant logs --> | ||
| <!--- To turn on SDK logging, follow instructions here: http://github.com/aws-sdk-kotlin/tree/main/docs/debugging.md --> | ||
| <!--- If service responses are relevant, please include wirelogs (after removing any sensitive content!) --> | ||
|
|
||
| ## Steps to Reproduce | ||
| <!--- If possible, provide a self-contained, concise snippet of code that can be used to reproduce the issue --> | ||
| <!--- For more complex issues provide a repo with the smallest sample that reproduces the bug --> | ||
| <!--- Avoid including business logic or unrelated code, it makes diagnosis more difficult --> | ||
|
|
||
| ## Possible Solution | ||
| <!--- Not required, but suggest a fix/reason for the bug --> | ||
|
|
||
| ## Context | ||
| <!--- How has this issue affected you? What are you trying to accomplish? --> | ||
| <!--- Providing context helps us come up with a solution that is most useful in the real world --> | ||
|
|
||
| ## Your Environment | ||
| <!--- Include as many relevant details about the environment where the bug was discovered --> | ||
| * AWS Kotlin SDK version used: | ||
| * Platform (JVM/JS/Native): | ||
| * Operating System and version: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| name: 📕 Documentation Issue | ||
| about: Report an issue in the API Reference documentation or Developer Guide | ||
| labels: documentation, needs-triage | ||
| --- | ||
|
|
||
| <!--- Provide a general summary of the issue in the Title above --> | ||
|
|
||
| ## Describe the issue | ||
| <!--- A clear and concise description of the issue --> | ||
|
|
||
| ## Links | ||
| <!-- Include links to affected documentation page(s) --> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| name: 💡 Feature Request | ||
| about: Suggest an idea for this project | ||
| labels: enhancement, needs-triage | ||
| --- | ||
|
|
||
| <!--- Provide a general summary of the issue in the Title above --> | ||
|
|
||
| <!-- Please keep this note for the community --> | ||
|
|
||
| ### Community Note | ||
|
|
||
| * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request | ||
| * Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request | ||
| * If you are interested in working on this issue, please leave a comment | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. comment This is outside of the scope of the PR but do we want to first tag issues as "help wanted" or "contributions welcome" or something to indicate what types of issues we'd like help with? If we go this route, then we make the first choice as to what we'd be interested in taking from the community. On the other hand, this kind of gating could reduce 3P participation.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think they are mutually exclusive. If someone wants to pick up an issue that isn't marked as "help wanted" then I say go for it. (Also we have a |
||
|
|
||
| <!-- Thank you for keeping this note for the community --> | ||
|
|
||
|
|
||
| ## Describe the Feature | ||
| <!--- A clear and concise description of the feature you are proposing --> | ||
|
|
||
| ## Is your Feature Request related to a problem? | ||
| <!--- A description of the issue, e.g. It would be great if... --> | ||
|
|
||
| ## Proposed Solution | ||
| <!--- Not required, but suggest how to implement the addition or change --> | ||
|
|
||
| ## Describe alternatives you've considered | ||
| <!--- Any alternative solutions or features you've considered --> | ||
|
|
||
| ## Additional Context | ||
| <!--- How has the lack of this feaure affected you? What are you trying to accomplish? --> | ||
| <!--- Providing context helps us come up with a solution that is most useful in the real world --> | ||
|
|
||
|
|
||
| - [ ] I may be able to implement this feature request | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <!--- Provide a general summary of your changes in the Title above --> | ||
|
|
||
| ## Issue \# | ||
| <!--- If it fixes an open issue, please link to the issue here --> | ||
|
|
||
| ## Description of changes | ||
| <!--- Why is this change required? What problem does it solve? --> | ||
|
|
||
|
|
||
| ## Scope | ||
| <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> | ||
| - [ ] Bug fix (non-breaking change which fixes an issue) | ||
| - [ ] New feature (non-breaking change which adds functionality) | ||
|
|
||
| By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,7 @@ reported the issue. Please try to include as much information as you can. Detail | |
| ## Contributing via Pull Requests | ||
| Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that: | ||
|
|
||
| 1. You are working against the latest source on the *master* branch. | ||
| 1. You are working against the latest source on the *main* branch. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 💥 |
||
| 2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already. | ||
| 3. You open an issue to discuss any significant work - we would hate for your time to be wasted. | ||
|
|
||
|
|
@@ -52,6 +52,6 @@ opensource-codeofconduct@amazon.com with any additional questions or comments. | |
|
|
||
| ## Licensing | ||
|
|
||
| See the [LICENSE](https://github.com/aws-samples/aws-sdk-kotlin/blob/master/LICENSE) file for our project's licensing. We will ask you confirm the licensing of your contribution. | ||
| See the [LICENSE](https://github.com/aws-samples/aws-sdk-kotlin/blob/main/LICENSE) file for our project's licensing. We will ask you confirm the licensing of your contribution. | ||
|
|
||
| We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # Debugging | ||
|
|
||
| ## Logging | ||
|
|
||
| ### JVM | ||
|
|
||
| For JVM targets, the Kotlin SDK uses the `slf4j` logger. The build configuration can be updated to enable log output. | ||
|
|
||
| While any `slf4j`-compatible log library may be used, here is an example to enable log output from the SDK in JVM | ||
| programs: | ||
|
|
||
| ``` | ||
| implementation("org.slf4j:slf4j-simple:1.7.30") | ||
| ``` | ||
|
|
||
| To view low-level request and response log output and the time of the log entry, specify this as JVM parameters to the executing program: | ||
|
|
||
| ``` | ||
| -Dorg.slf4j.simpleLogger.defaultLogLevel=TRACE -Dorg.slf4j.simpleLogger.showDateTime=true | ||
| ``` | ||
|
|
||
| The log level can be adjusted up as needed to DEBUG, INFO, WARN, or ERROR. [See here](http://www.slf4j.org/api/org/slf4j/impl/SimpleLogger.html) for all properties for the simple logger. | ||
|
|
||
|
|
||
| #### CRT Logs | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. TIL |
||
|
|
||
| JVM system properties for CRT related logs | ||
|
|
||
|
|
||
| | Property | Description | | ||
| | ----------------------------| -----------------------------------------------------------------------------------------------------------------| | ||
| | `aws.crt.log.level` | Specify log level `None`, `Fatal`, `Error`, `Warn`, `Info`, `Debug`, `Trace` | | ||
| | `aws.crt.log.destination` | The destination to log to `None`, `Stdout`, `Stderr`, `File`. By default when level is not `None` stderr is used | | ||
| | `aws.crt.log.filename` | Redirect logs to a file | | ||
|
|
||
|
|
||
| ## Error Metadata | ||
|
|
||
| The raw protocol response is usually available on exceptions if you need access to additional response details (headers, status code, etc). | ||
|
|
||
|
|
||
| ```kotlin | ||
| try { | ||
| ... | ||
| } catch(ex: AwsServiceException) { | ||
| val httpResp = ex.sdkErrorMetadata.protocolResponse as? HttpResponse | ||
| if (httpResp != null) { | ||
| println(httpResp.headers) | ||
| println(httpResp.body.readAll()?.decodeToString()) | ||
| } | ||
| } | ||
| ``` | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Use sentence case for issue names
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't the name of the issue created it's the template name. You can see an example by going to the java sdk and clicking on create issue