CONTRIBUTING.md

CONTRIBUTING TO EMBER ABSTRACT DROPDOWN

TABLE OF CONTENTS

• CONTRIBUTING TO EMBER ABSTRACT DROPDOWN
  • TABLE OF CONTENTS
  • GETTING THE CODE
  • SETTING UP THE ENVIRONMENT
    • Generating the GPG Key
    • Setting up Git Config Locally
  • BUILDING AND TESTING

GETTING THE CODE

git clone https://github.com/houseninjadojo/ember-capacitor
cd embroider-template
npm i

SETTING UP THE ENVIRONMENT

Generating the GPG Key

Embroider Template requires that every commit be signed before it is accepted for merging into the main branch prior to release.

All contributors are expected to create a GPG Key and use it to sign all their commits during the development process. At the very minimum, all Pull Requests are expected to be signed by the contributors' GPG Key prior to being accepted.

Please follow the Github guide on Managing commit signature verification for instructions on how to get this done.

Setting up Git Config Locally

git config commit.gpgsign true

git config trailer.sign.key "Signed-off-by: "
git config trailer.sign.ifmissing add
git config trailer.sign.ifexists doNothing
git config trailer.sign.command 'echo "$(git config user.name) <$(git config user.email)>"'

git config user.name "YOUR NAME"
git config user.email "your.name@twyr.com"
git config user.signingKey "GPG Key Id"

BUILDING AND TESTING

Operation	NPM Script / Command
Building Everything	npm run build --workspaces
Clean Building Everything	npm run build:clean --workspaces
Linting	npm run lint --workspaces
Linting with fixes	npm run lint:fix --workspaces
Running the Tests	npm run test --workspaces