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
+15-17Lines changed: 15 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -1,29 +1,28 @@
1
1
# Contributing Guidelines
2
2
3
-
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
3
+
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
4
4
documentation, we greatly value feedback and contributions from our community.
5
5
6
-
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
6
+
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7
7
information to effectively respond to your bug report or contribution.
8
8
9
-
10
9
## Reporting Bugs/Feature Requests
11
10
12
11
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13
12
14
-
When filing an issue, please check [existing open](https://github.com/aws/aws-sdk-js-crypto-helpers/issues), or [recently closed](https://github.com/aws/aws-sdk-js-crypto-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
13
+
When filing an issue, please check [existing open](https://github.com/aws/aws-sdk-js-crypto-helpers/issues), or [recently closed](https://github.com/aws/aws-sdk-js-crypto-helpers/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
15
14
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16
15
17
-
* A reproducible test case or series of steps
18
-
* The version of our code being used
19
-
* Any modifications you've made relevant to the bug
20
-
* Anything unusual about your environment or deployment
21
-
16
+
- A reproducible test case or series of steps
17
+
- The version of our code being used
18
+
- Any modifications you've made relevant to the bug
19
+
- Anything unusual about your environment or deployment
22
20
23
21
## Contributing via Pull Requests
22
+
24
23
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
25
24
26
-
1. You are working against the latest source on the *master* branch.
25
+
1. You are working against the latest source on the _master_ branch.
27
26
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28
27
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
29
28
@@ -36,23 +35,22 @@ To send us a pull request, please:
36
35
5. Send us a pull request, answering any default questions in the pull request interface.
37
36
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
38
37
39
-
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
38
+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40
39
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
41
40
42
-
43
41
## 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/aws/aws-sdk-js-crypto-helpers/labels/help%20wanted) issues is a great place to start.
45
42
43
+
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/aws/aws-sdk-js-crypto-helpers/labels/help%20wanted) issues is a great place to start.
46
44
47
45
## 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
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
52
53
+
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.
AWS Cryptographic Helpers for Javascript and Node.js
3
4
4
5
## Scope
6
+
5
7
This repository collects cryptographic helper packages. We have designed it to gather packages that implement simple primitives for the browser or Node.js. More information about AWS Crypto Tools can be found [here](https://docs.aws.amazon.com/aws-crypto-tools/index.html?id=docs_gateway#lang/en_us)
6
8
7
9
## Project Status
10
+
8
11
This project is still in its early stages. Please send us your feedback. We might make breaking changes in future releases while the SDK is still in developer preview.
9
12
10
13
## Getting started
14
+
11
15
Let’s walk through setting up a project that requires a cryptographically secure random value. The following steps use npm as an example. They assume you have node.js and npm already installed.
12
-
1. Create a new node.js project.
13
-
2. In the project, run: `npm install --save @aws-crypto/random-source-node@preview`
14
-
3. Create a new file called index.js, require the function, and then use it to get a random value.
16
+
17
+
1. Create a new node.js project.
18
+
2. In the project, run: `npm install --save @aws-crypto/random-source-node@preview`
19
+
3. Create a new file called index.js, require the function, and then use it to get a random value.
0 commit comments