2
2
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-11-01 03:02:32 +00:00
nativefier/.github/CONTRIBUTING.md
Ronan Jouchet 0fbe7d39cb Build: re-introduce a package-lock.json file
They were used a long time ago, then I scrapped them for simplicity to
new contributors. I'm re-considering this and re-introducing one, for
two (maybe three) reasons:

1. Reading on supply chain attacks
2. Build broken because of a dep change (see previous commit broken
   because of a change in yargs @ 17.1.0)
(3.) Performance
2021-09-20 11:25:43 -04:00

31 lines
808 B
Markdown

# Contributing to Nativefier
## Issues
Please include the following in your new issue:
- Version of Nativefier (run `$ nativefier --version`)
- Version of Node.js (run `$ node --version`)
- Command line parameters
- OS and architecture you are running Nativefier from
- Stack trace from the error message (if any)
- Instructions to reproduce the issue
## Pull Requests
See [here](https://github.com/nativefier/nativefier#development) for instructions on how to set up a development environment.
We follow the [Airbnb Style Guide](https://github.com/airbnb/javascript), please make sure tests and lints pass when you submit your pull request.
The following commands might be helpful:
```bash
# Run specs only
npm run test
# Run linter only
npm run lint
```
Thank you so much for your contribution!