Skip to content

Commit 086714c

Browse files
authored
chore: merge pull request #157 from awslabs/develop
2 parents b9d7519 + 563a468 commit 086714c

35 files changed

+747
-746
lines changed

.eslintrc.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
module.exports = {
2+
extends: 'standard',
3+
globals: {
4+
test: true,
5+
expect: true,
6+
describe: true,
7+
jest: true
8+
}
9+
};

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1+
Please ensure all pull requests are made against the `develop` branch.
2+
13
*Issue #, if available:*
24

35
*Description of changes:*
46

5-
67
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

.jshintrc

Lines changed: 0 additions & 11 deletions
This file was deleted.

.travis.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ node_js:
44
- 4
55
- 6
66
- 8
7-
# - node # Latest; NOTE: latest does not work due to Buffer deprecation
7+
# - node # runs tests against latest version of Node.js for future-proofing
88

99
before_install:
1010
- echo 'Installing example dependencies...'
11-
- cd example && npm install && cd ..
11+
- npm run install-example-dependencies
1212
- echo 'Example dependencies installed!'
1313

1414
jobs:
@@ -19,6 +19,7 @@ jobs:
1919
- stage: lint
2020
script:
2121
- commitlint-travis
22+
- npm run lint
2223
- stage: deploy
2324
script: skip
2425
node_js: 8 # semantic-release requires Node >= 8.3

CONTRIBUTING.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,22 @@
11
# Contributing Guidelines
22

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.
84

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.
96

107
## Reporting Bugs/Feature Requests
118

129
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
1310

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:
1612

1713
* A reproducible test case or series of steps
1814
* The version of our code being used
1915
* Any modifications you've made relevant to the bug
2016
* Anything unusual about your environment or deployment
2117

22-
2318
## Contributing via Pull Requests
19+
2420
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
2521

2622
1. You are working against the latest source on the *master* branch.
@@ -36,23 +32,19 @@ To send us a pull request, please:
3632
5. Send us a pull request, answering any default questions in the pull request interface.
3733
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
3834

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/).
4236

4337
## 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.
4538

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.
4640

4741
## 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
50-
[email protected] with any additional questions or comments.
5142

43+
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.
5244

5345
## 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.
5546

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.
5648

5749
## Licensing
5850

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ exports.handler = (event, context) => awsServerlessExpress.proxy(server, event,
2525

2626
## Quick Start/Example
2727

28-
Want to get up and running quickly? [Check out our example](example) which includes:
28+
Want to get up and running quickly? [Check out our basic starter example](examples/basic-starter) which includes:
2929

3030
- Lambda function
3131
- Express server

__tests__/index.js

Lines changed: 0 additions & 241 deletions
This file was deleted.

0 commit comments

Comments
 (0)