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
d6bb1c2e37
github-pages-deploy-action/CONTRIBUTING.md
James Ives 4b2f84d384
Version 3 (#44) 
* Version 3 Beta

* README Updates

* More readme updates

* lock

* Restoring license/contrib

* One set of tests

* linting

* More tests

* Finish up unit tests

* Update action.yml

* Update main.yml

* Update README.md

* Update README.md

* README Changes

* Update README.md

* Unit testing job

* Some more stuff

* More cleanup

* Update README.md

* Unrequired

* Update CONTRIBUTING.md

* no guess

* Using Git Switch as opposed to checkout

* Force Commit

* Remove git

* Some more simplification

* Update git.ts

* changes

* Options

* w

* Debugging

* More debugging

* More debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debugging

* Debug

* Debugging

* Another 1

* Update git.ts

* Fixes root deployment

* Quiet Mode

* Quiet

* Excluding .github

* Update README.md
2019-11-19 10:06:27 -05:00

1.2 KiB
Raw Blame History

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Pull Request Best Practices

  1. Ensure that you've tested your feature/change yourself. As the primary focus of this project is deployment, providing a link to a deployed repository using your branch is preferred. You can reference the forked action using your GitHub username, for example yourname/github-pages-deplpy-action@master.
  2. Make sure you update the README if you've made a change that requires documentation.
  3. When making a pull request, highlight any areas that may cause a breaking change so the maintainer can update the version number accordingly on the GitHub marketplace.

Deploying

In order to deploy and test your own fork of this action, you must commit the required node_modules dependencies.

To do this you can follow the instructions below:

# comment out in distribution branches
# node_modules/

$ git checkout -b branchnamehere
$ git commit -a -m "prod dependencies"

The node_modules folder should not be included when making a pull request.