adk23333/github-pages-deploy-action
1
0
Fork 0
mirror of https://github.com/JamesIves/github-pages-deploy-action.git synced 2023-12-15 20:03:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
James Ives 2020-03-31 08:48:19 -04:00 committed by GitHub
parent 9a3cf1925d
commit cecb5ccb7b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
CONTRIBUTING.md
View File

@ -11,18 +11,33 @@ email, or any other method with the owners of this repository before making a ch
# Deploying
In order to deploy and test your own fork of this action, you must commit the required `node_modules` dependencies.
In order to deploy and test your own fork of this action, you must commit the required `node_modules` dependencies. Be sure to run `nvm use` before installing any dependencies. You can learn more about nvm [here](https://github.com/nvm-sh/nvm/blob/master/README.md).
To do this you can follow the instructions below:
Install the project:
```
yarn install
```
Comment out the following in distribution branches:
```
# comment out in distribution branches
# node_modules/
```
Build the project:
```
yarn build
```
Commit:
```
$ git checkout -b branchnamehere
$ git commit -a -m "prod dependencies"
```
The `node_modules` folder should _not_ be included when making a pull request.
The `node_modules` folder should _not_ be included when making a pull request. These are only required for GitHub Actions when it consumes the distribution branch branch, the `dev` branch of the project should be free from any dependencies or lib files.