Skip to content

Latest commit

 

History

History
93 lines (57 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

93 lines (57 loc) · 1.99 KB

logo

dirgistered

Contributing

general

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.

jsdocs

The current jsdoc documentation can be found on https://yafp.github.io/dirgistered/. It is auto-generated on each commit.

CI

The project repository is using:

for Continuos Integration aspects.

Building dirgistered

Build instructions can be found here.

Sentry (Crashreports)

Crashreport informations are located here. More informations about dirgistered sentry usage are located here.

Getting started

1. First steps

Clone repo
  • Clone the repository: git clone https://github.com/yafp/dirgistered
Install dependencies
  • Go into the repository: cd dirgistered
  • Install dependencies: npm install
Run the code
  • Execute: npm start
Run the code with debug logging
  • Execute npm run start-debug
Run some basic test
  • Execute: npm test

2. Misc howto's

Auditing
npm auditing (scan for vulnerabilities)
  • npm audit
Outdated packages
check for outdated npm packages
  • npm outdated

or using npm-check:

  • Install requirements: npm install -g npm-check
  • Run check: npm-check or
  • Run check: npm-check -s
Updating
check dependencies
  • Install requirements: npm install depcheck
  • Run check: depcheck
update all packages
  • npm update
Others
List all package.json scripts
  • npm run

or a dynamic solution

  • Install requirements: npm i -g ntl
  • Execute ntl