From a3009d574332e690a1c14a84de1c0ad9e5ced725 Mon Sep 17 00:00:00 2001 From: James Ives Date: Sat, 16 May 2020 13:37:08 -0400 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1f0a125..1a390480 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,18 +1,19 @@ -# Contributing +# 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. +[email, or any other method with the owners of this repository](https://jamesiv.es) before making a change. -## Before Making a Pull Request +## Before Making a Pull Request 🎒 -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. -4. Make sure you've formatted and linted your code. You can do this by running `yarn format` and `yarn lint`. -5. Fix or add any tests where applicable. You can run `yarn test` to run the suite. As this action is small in scope it's important that a high level of test coverage is maintained. All tests are written using Jest. -6. Ensure all typing is accurate and the action compiles correctly by running `yarn build`. +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. Ensure your change passes all of the integration tests. +3. Make sure you update the README if you've made a change that requires documentation. +4. 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 and package registries. +5. Make sure you've formatted and linted your code. You can do this by running `yarn format` and `yarn lint`. +6. Fix or add any tests where applicable. You can run `yarn test` to run the suite. As this action is small in scope it's important that a high level of test coverage is maintained. All tests are written using [Jest](https://jestjs.io/). +7. As this package is written in [TypeScript](https://www.typescriptlang.org/) please ensure all typing is accurate and the action compiles correctly by running `yarn build`. -# Deploying +## Deploying 🚚 In order to deploy and test your own fork of this action, you must commit the `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). @@ -43,4 +44,4 @@ $ git checkout -b branchnamehere $ git commit -a -m "prod dependencies" ``` -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, the `dev` branch of the project should be free from any dependencies or lib files. \ No newline at end of file +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, the `dev` branch of the project should be free from any dependencies or lib files.