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
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
38
39
39
-
When filing an issue, please check [existing open](https://github.com/awslabs/smithy-typescript/issues), or [recently closed](https://github.com/awslabs/smithy-typescript/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
40
+
When filing an issue, please check [existing open](https://github.com/smithy-lang/smithy-typescript/issues), or [recently closed](https://github.com/smithy-lang/smithy-typescript/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
40
41
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
41
42
42
-
* A reproducible test case or series of steps
43
-
* The version of our code being used
44
-
* Any modifications you've made relevant to the bug
45
-
* Anything unusual about your environment or deployment
46
-
43
+
- A reproducible test case or series of steps
44
+
- The version of our code being used
45
+
- Any modifications you've made relevant to the bug
46
+
- Anything unusual about your environment or deployment
47
47
48
48
## Contributing via Pull Requests
49
+
49
50
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
50
51
51
-
1. You are working against the latest source on the *main* branch.
52
+
1. You are working against the latest source on the _main_ branch.
52
53
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
53
54
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
54
55
@@ -78,33 +79,34 @@ Any changes made to the `smithy-typescript-codegen` package need to be compatibl
78
79
MUST ensure that code generation is kept in sync between the two repositories by creating an equivalent PR in aws-sdk-js-v3.
79
80
80
81
Procedure to keep code generation in sync while making changes to `smithy-typescript-codegen`:
82
+
81
83
1. Fork and clone [aws/aws-sdk-js-v3][aws-sdk-js-v3].
82
84
2. Run `yarn` to install dependencies.
83
85
3. Run `generate-clients` with `HEAD` commit as follows:
84
-
```sh
85
-
yarn generate-clients --commit HEAD
86
-
```
86
+
```sh
87
+
yarn generate-clients --commit HEAD
88
+
```
87
89
4. If the clients are updated, post a pull request on aws-sdk-js-v3. If the clients are not updated, no further action is needed.
88
90
5. When PR on smithy-typescript is merged, rebase the PR on aws-sdk-js-v3 and add merged commit as default.
89
91
90
92
## Finding contributions to work on
91
-
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'](https://github.com/awslabs/smithy-typescript/labels/help%20wanted) issues is a great place to start.
92
93
94
+
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'](https://github.com/smithy-lang/smithy-typescript/labels/help%20wanted) issues is a great place to start.
93
95
94
96
## Code of Conduct
97
+
95
98
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
96
99
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do**not** create a public github issue.
102
103
104
+
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
103
105
104
106
## Licensing
105
107
106
-
See the [LICENSE](https://github.com/awslabs/smithy-typescript/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
108
+
See the [LICENSE](https://github.com/smithy-lang/smithy-typescript/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
107
109
108
110
We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
0 commit comments