Contribution Documentation

This commit is contained in:
James Ives 2019-09-24 21:10:32 -04:00 committed by GitHub
parent c3d5102651
commit 2641b391f2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

10
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,10 @@
# 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 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.