From 60a05a0e408b09d654a9154424ef12464a904055 Mon Sep 17 00:00:00 2001 From: CptSpaceToaster Date: Sat, 12 Oct 2019 14:45:58 -0400 Subject: [PATCH] Update contributing instructions --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index eaf4a00..836f5dc 100644 --- a/README.md +++ b/README.md @@ -141,6 +141,12 @@ PokemonTCG.Card.all() ## Contributing * Fork it (click the Fork button at the top of the page) * Create your feature branch (git checkout -b my-new-feature) + * Make some changes and fix some bugs! + * Run the tests `npm run-script test` + * Test your changes in a project of yours: + * Create a link with (npm)[https://docs.npmjs.com/cli/link.html] or (yarn)[https://yarnpkg.com/lang/en/docs/cli/link/] (depending on what tool you installed this SDK with) + * In your project that **uses** the SDK, install the linked package with `yarn/npm link pokemon-tcg-sdk-typescript` + * Verify the SDK behaves as expected, and your changes took effect * Commit your changes (git commit -am 'Add some feature') * Push to the branch (git push origin my-new-feature) * Create a new Pull Request