Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

80 lines (56 loc) · 1.92 KB
Raw

< 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.

HowTo execute tests

  • launch tests using npm test.

Think about environment setup.

Basis reminder

Clone this repository from GitHub:

$ git clone https://github.com/boly38/botEnSky.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 template
  • copy the template in a private file
cp ./env/.env.template ./env/.env.development

Start the bot

Execute the application

npm run startDev

or (production mode)

npm run start

PullRequests additional information

Activated bot:

Maintainer HowTos

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 Gren

# provide PAT with permissions to create release on current repository
export GREN_GITHUB_TOKEN=your_token_here
# one time setup
npm install github-release-notes -g

git fetch --all && git pull
# make a release vX with all history
gren release --data-source=prs -t v2.2.2 --milestone-match=v2.2.2
# overrides release vX with history from vX-1
gren release --data-source=prs -t "v2.2.2..v2.2.1" --milestone-match="v2.2.2" --override