sjs/mit-license
1
0
Fork 0
mirror of https://github.com/samsonjs/mit-license.git synced 2026-03-25 09:25:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add instructions on development environment setup

Browse source 
Signed-off-by: Richie Bendall <richiebendall@gmail.com>
This commit is contained in:
Richie Bendall 2021-08-15 16:01:55 +12:00
parent 27145b5b8d
commit c90ff05f87
No known key found for this signature in database
GPG key ID: 1C6A99DFA9D306FC
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -1,9 +1,13 @@
# Contributing
# Development environment setup
With [Node.js](https://nodejs.dev) installed, [`git clone` the repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository#cloning-a-repository) then run `npm install` and `npm run dev` to start the development server.
# Merging user updates
If you are a collaborator (with push permissions), you can merge any open PR with the following conditions:
1. It passes the JSON validity test (this is a GitHub integration in Travis CI)
2. Merge anything that adds or updates a `<user>.json` file
2. It adds or updates a `<user>.json` file
If you're unsure, cc @remy into the PR with a question and we can work out what to do.