Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (43 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

64 lines (43 loc) · 1.83 KB

< Back

HowTo Contribute

Please create an issue describing your goal / question / bug description...

If you're interested in an existing issue, please contribute by up-voting for it by adding a 👍.

If you want to push some code :

  • fork and prepare a feature-git-branch, then create a pull request that link your issue.
  • execute tests

You could also be critic with existing ticket/PR : all constructive feedbacks are welcome.

Basis reminder

Clone this repository from GitHub:

$ git clone https://github.com/creharmony/node-etsy-client.git

Prerequisites

  1. Install NodeJs (https://nodejs.org/en/download/)
  2. Install dependencies
npm install

Set your own private environment

  • study each required environment variable in the initEnv.example.sh
  • copy the template in a private file
cp ./env/initEnv.example.sh ./env/initEnv.dontpush.sh
. ./env/initEnv.dontpush.sh

HowTo execute tests

  • launch tests using npm test.

Think about environment setup.

Maintainer HowTo

HowTo create a fresh version

  • use patch or minor or major workflow

this will make a new version and on version tag, the main ci workflow will push a new npmjs version too.

HowTo release using gh

Install and create automatically a draft release version using gh client

  • the version tag must exist

Example to create v2.0.1

gh release create v2.0.1 --draft --generate-notes

this will make a new draft release. Verify it in releases list

  • ⚠️ the repository apply immutable releases since v2.0.1, so you can't modify a release once published
  • publish the release when ready