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
* refactor: restructure; add eslint and fix; new Buffer to Buffer.from
* test: add lint-staged; fix Travis
* test: install example dependencies before running test
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-16Lines changed: 8 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,26 +1,22 @@
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
4
-
documentation, we greatly value feedback and contributions from our community.
5
-
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.
3
+
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.
8
4
5
+
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.
9
6
10
7
## Reporting Bugs/Feature Requests
11
8
12
9
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13
10
14
-
When filing an issue, please check [existing open](https://github.com/awslabs/aws-serverless-express/issues), or [recently closed](https://github.com/awslabs/aws-serverless-express/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:
11
+
When filing an issue, please check [existing open](https://github.com/awslabs/aws-serverless-express/issues), or [recently closed](https://github.com/awslabs/aws-serverless-express/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16
12
17
13
* A reproducible test case or series of steps
18
14
* The version of our code being used
19
15
* Any modifications you've made relevant to the bug
20
16
* Anything unusual about your environment or deployment
21
17
22
-
23
18
## Contributing via Pull Requests
19
+
24
20
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
25
21
26
22
1. You are working against the latest source on the *master* branch.
@@ -36,23 +32,19 @@ To send us a pull request, please:
36
32
5. Send us a pull request, answering any default questions in the pull request interface.
37
33
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
38
34
39
-
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40
-
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
41
-
35
+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
42
36
43
37
## 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/${GITHUB_ORG}/${GITHUB_REPO}/labels/help%20wanted) issues is a great place to start.
45
38
39
+
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/${GITHUB_ORG}/${GITHUB_REPO}/labels/help%20wanted) issues is a great place to start.
46
40
47
41
## 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
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact [email protected] with any additional questions or comments.
52
44
53
45
## 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
46
47
+
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.
0 commit comments