Browse Source

misc: Standartize README.md

develop
Dale 1 year ago
parent
commit
89a9f41d28
  1. 20
      README.md

20
README.md

@ -57,11 +57,17 @@ For every common distro, ensure you're using NodeJS >14.0 and yarn with the same
* Lint and fix files `yarn lint`
* Customize configuration (See [Configuration Reference](https://cli.vuejs.org/config/)).
## Contribution Checklist
# Contributing
* When contributing, please make sure that your changes produce usable output
1. NixOS: run `nix-build` and check `./result/dist` for usable output
2. Other Distros: run `yarn build` and check `./dist/` for usable output
* When adding new yarn packages, make sure to re-generate yarn.nix by running `yarn2nix > yarn.nix`
1. NixOS: `yarn2nix` should be already available under `nix-shell`
2. Other Distros: Carefuly mention that you can't do that when submiting a PR, but lower your voice to avoid raising suspicions
### Nix / NixOS
* Make sure that `nix-build` produces usable output.
1. An output is considered usable if `./result/dist` contains desired frontend, i.e. if servable with `http-server` and functioning
* If adding a new package, do not forget to generate new `yarn.nix` by running `yarn2nix > yarn.nix`
1. `yarn2nix` should be available inside `nix-shell`
2. A good idea is to run `nix-collect-garbage && nix-build` after that to make sure project builds
### Other Distros
* Make sure that `yarn build` produces usable output
1. An output is considered usable if `./dist/` contains desired frontend, i.e. if servable with `http-server` and functioning
* If adding a new package, mention that you cannot update `yarn.nix` when opening a pull-request
1. Somebody should be able to update it and commit it into your pull-request or otherwise help you out
Loading…
Cancel
Save