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
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
4
-
documentation, we greatly value feedback and contributions from our community.
3
+
Thank you for your interest in contributing to our project.
4
+
Whether it's a bug report, new feature, correction, or additional documentation,
5
+
we greatly value feedback and contributions from our community.
5
6
6
-
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7
-
information to effectively respond to your bug report or contribution.
7
+
Please read through this document before submitting any issues
8
+
or pull requests to ensure we have all the necessary information
9
+
to effectively respond to your bug report or contribution.
8
10
9
11
10
12
## Reporting Bugs/Feature Requests
11
13
12
14
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13
15
14
-
When filing an issue, please check [existing open](https://github.com/awslabs/aws-encryption-sdk-javascript/issues), or [recently closed](https://github.com/awslabs/aws-encryption-sdk-javascript/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
15
-
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16
+
When filing an issue, please check [existing open][issues], or [recently closed][recently closed],
17
+
issues to make sure somebody else hasn't already
18
+
reported the issue.
19
+
Please try to include as much information as you can. Details like these are incredibly useful:
16
20
17
21
* A reproducible test case or series of steps
18
22
* The version of our code being used
@@ -21,18 +25,26 @@ reported the issue. Please try to include as much information as you can. Detail
21
25
22
26
23
27
## Contributing via Pull Requests
24
-
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
28
+
Contributions via pull requests are much appreciated.
29
+
Before sending us a pull request, please ensure that:
25
30
26
31
1. You are working against the latest source on the *master* branch.
27
-
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
32
+
2. You check existing open, and recently merged,
33
+
pull requests to make sure someone else hasn't addressed the problem already.
28
34
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
29
35
30
36
To send us a pull request, please:
31
37
32
38
1. Fork the repository.
33
-
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
39
+
2. Modify the source; please focus on the specific change you are contributing.
40
+
If you also reformat all the code, it will be hard for us to focus on your change.
34
41
3. Ensure local tests pass.
35
42
4. Commit to your fork using clear commit messages.
43
+
Your commit tile and message and pull request title and description must adhere to
44
+
[conventional commits][conventional commits]. Title must begin with `feat(module): title`,
Title should be lowercase and not period at the end of it. If the commit includes
47
+
a breaking change, the commit message must end with a single paragraph: `BREAKING CHANGE: a description of what broke`
36
48
5. Send us a pull request, answering any default questions in the pull request interface.
37
49
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
38
50
@@ -41,21 +53,37 @@ GitHub provides additional document on [forking a repository](https://help.githu
41
53
42
54
43
55
## Finding contributions to work on
44
-
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/aws-encryption-sdk-javascript/labels/help%20wanted) issues is a great place to start.
56
+
Looking at the existing issues is a great way to find something to contribute on.
57
+
As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix),
58
+
looking at any [help wanted][help wanted] issues is a great place to start.
45
59
46
60
47
61
## Code of Conduct
48
-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49
-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
62
+
This project has adopted the [Amazon Open Source Code of Conduct][code of conduct].
63
+
For more information see the [Code of Conduct FAQ][code of conductfaq] or contact
50
64
opensource-codeofconduct@amazon.com with any additional questions or comments.
51
65
52
66
53
67
## Security issue notifications
54
-
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.
55
-
68
+
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security
69
+
via our [vulnerability reporting page][vulnerability reporting].
70
+
Please do **not** create a public github issue.
56
71
57
72
## Licensing
58
73
59
-
See the [LICENSE](https://github.com/awslabs/aws-encryption-sdk-javascript/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
74
+
See the [LICENSE][license] file for our project's licensing.
75
+
We will ask you to confirm the licensing of your contribution.
76
+
77
+
We may ask you to sign a [Contributor License Agreement (CLA)][cla] for larger changes.
0 commit comments