Skip to content
This repository was archived by the owner on Jun 21, 2023. It is now read-only.

Commit 21582e1

Browse files
committed
adding readme updates and basic files
1 parent 47eedcc commit 21582e1

2 files changed

Lines changed: 59 additions & 1 deletion

File tree

.github/CONTRIBUTING.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing
2+
:wave: Hi there!
3+
We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
4+
5+
## Submitting a pull request
6+
[Pull Requests][pulls] are used for adding new playbooks, roles, and documents to the repository, or editing the existing ones.
7+
8+
**With write access**
9+
1. Clone the repository (only if you do not have write access)
10+
1. Create a new branch: `git checkout -b my-branch-name`
11+
1. Make your change
12+
1. Push and [submit a pull request][pr]
13+
1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
14+
15+
**Without write access**
16+
1. [Fork][fork] and clone the repository
17+
1. Create a new branch: `git checkout -b my-branch-name`
18+
1. Make your change
19+
1. Push to your fork and [submit a pull request][pr]
20+
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
21+
22+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
23+
24+
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
25+
- Write [good commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
26+
27+
Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocking you.
28+
29+
- Create a branch with a name that identifies the user and nature of the changes (similar to `user/branch-purpose`)
30+
- Open a pull request and request a review from a member of the appropriate `@github/services-account-engineering` and/or `@github/services-engineering` teams
31+
32+
## Resources
33+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
34+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
35+
- [GitHub Help](https://help.github.com)
36+
37+
[pulls]: https://github.com/github/github-demo-stack/pulls
38+
[pr]: https://github.com/github/github-demo-stack/compare
39+
[fork]: https://github.com/github/github-demo-stack/fork

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,21 @@
11
# deploy-nodejs
2-
GitHub Action to deploy a NodeJS app to AWS Serverless
2+
3+
This repository is for the **GitHub** Action to deploy a **NodeJS** application to **AWS** Serverless.
4+
Developers on **GitHub** can call this Action to take their current **NodeJS** application, and pass basic variables to help deploy
5+
6+
## How to use
7+
8+
To use this **GitHub** Action you will need to complete the following:
9+
- ?
10+
- ?
11+
- ?
12+
13+
## How to contribute
14+
15+
If you would like to help contribute to this **Github** Action, please see [CONTRIBUTING](https://github.com/github/deploy-nodejs/blob/master/.github/CONTRIBUTING.md)
16+
17+
--------------------------------------------------------------------------------
18+
19+
### License
20+
21+
- [License](https://github.com/github/deploy-nodejs/blob/master/LICENSE)

0 commit comments

Comments
 (0)