Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve contribution docs and remove unused package script #1066

Merged
19 changes: 19 additions & 0 deletions .gitignore
Expand Up @@ -8,3 +8,22 @@ docker-compose-logs
package-lock.json
dist/static/
dist/views/

# OS
.DS_Store

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace
8 changes: 4 additions & 4 deletions README.md
Expand Up @@ -355,13 +355,13 @@ If you have Node v10+ installed locally, you can run the tests, and a local app,

```sh
# Install dependencies
yarn
yarn install

# Run the tests
npm test
yarn test

# Run the app locally
npm run dev
jetersen marked this conversation as resolved.
Show resolved Hide resolved
yarn test:watch
```

Once you've started the app, visit `localhost:3000` and you'll get [step-by-step instructions](https://probot.github.io/docs/development/#configuring-a-github-app) for installing it in your GitHub account so you can start pushing commits and testing it locally.
Expand All @@ -370,7 +370,7 @@ If you don’t have Node installed, you can use [Docker Compose](https://docs.do

```sh
# Run the tests
docker-compose run --rm app npm test
docker compose run --rm app
```

## Contributing
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Expand Up @@ -7,5 +7,5 @@ services:
context: .
args:
NODE_ENV: development
command: ['npm', 'test']
command: ['yarn', 'test']
entrypoint: ''
3 changes: 1 addition & 2 deletions package.json
Expand Up @@ -8,14 +8,13 @@
"repository": "https://github.com/release-drafter/release-drafter",
"scripts": {
"build": "ncc build action.js --target es2021",
"dev": "nodemon --exec \"npm start\"",
"start": "probot run ./index.js",
"test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
"test:watch": "node --experimental-vm-modules node_modules/jest/bin/jest.js --watch --notify --notifyMode=change --coverage",
"generate-schema": "node ./bin/generate-schema.js print",
"generate-fixtures": "node ./bin/generate-fixtures.js",
"lint": "eslint bin/*.js lib/*.js action.js index.js test/**/*.js",
"prettier": "prettier --write **/*.{js,md,json,yml,yaml}",
"prettier": "prettier --write **/*.{js,md,json,yml}",
"postversion": "npm run test && git push && git push --tags",
"open-releases": "open \"$(node -e 'console.log(`${require(\"./package.json\").repository}/releases`)')\"",
"deploy": "git push -f heroku \"$(node -e 'console.log(`v${require(\"./package.json\").version}`)')\":master",
Expand Down