diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1a35c03 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +## Developing for Planner +In order to develop for planner ensure you have node version 18 installed as a prerequisite. https://nodejs.org/en/ +1. Open up a terminal/cmd and go to the root of the project +2. Run `npm install` to install the necessary packages to validate js. +3. Now you can simply run `npm run validate` +4. Output should look similar to below for both. + + +Once you've committed you changes, open a Merge Request! Please include a description of what your change does, and as applicable, a screenshot of what your changes look like. + +## I clicked "Request Access", why don't I have it yet? + +How about you start by opening some Merge Requests? You don't need any access you don't already have to either use this plugin or contribute to its development! + diff --git a/README.md b/README.md index 39a1200..d72fd7d 100644 --- a/README.md +++ b/README.md @@ -120,3 +120,8 @@ I suggested to provide patches to the original version in order to fix some issu 5. Allow to remove candidates from the map. 6. Layout improvements to the edit dialog. 7. Anything that comes after renaming it to "Wayfarer planner." https://gitlab.com/NvlblNm/wayfarer/commits/master + +## I want to help! + +Awesome, check out [CONTRIBUTING](CONTRIBUTING.md) to get started! + diff --git a/assets/developer_output.png b/assets/developer_output.png new file mode 100644 index 0000000..4ae6ff0 Binary files /dev/null and b/assets/developer_output.png differ diff --git a/package.json b/package.json index 3b2e318..d942034 100644 --- a/package.json +++ b/package.json @@ -1,4 +1,7 @@ { + "scripts" : { + "validate": "npx eslint --format gitlab --fix *.js && npx prettier --write *.js && npx prettier --check *.js" + }, "dependencies": { "eslint-config-standard": "^17.0.0", "prettier": "^2.8.3"