-
Notifications
You must be signed in to change notification settings - Fork 649
Improve contribution docs #901
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
Comments
@donalmurtagh was there anything else to add to this, did you need to install webpack/eslint globally with -g to get build to work for example? |
@donalmurtagh would this suffice? How to setup to developTo get started clone all json-schema-form library repos into sibling folders. git clone https://github.com/json-schema-form/json-schema-form-core.git
git clone https://github.com/json-schema-form/angular-schema-form.git
git clone https://github.com/json-schema-form/angular-schema-form-bootstrap.git
git clone https://github.com/json-schema-form/angular-schema-form-material.git Install Node.js for your development environment. Currently working in Node v8.1.2 at least. Install dev/global dependencies and bower references to use demo site npm install
npm install -g webpack eslint mocha # json-schema-form-core
npm install -g webpack eslint karma # angular-schema-form
bower install Once cloned each repo has npm commands for assisting development npm run test # Run unit tests
npm run build # Run the build
npm run dist # not in json-schema-form-core # Run the build and minify
npm run watch # Run the build and watch for changes |
@donalmurtagh please re-open if you have more to add or think there's anything else I should add? |
I was trying to setup a local development environment for angular-schema-form. Here's what I did:
CONTRIBUTING.md
CONTRIBUTING.md
)npm install
(this was not mentioned inCONTRIBUTING.md
)bower install
(this was not mentioned inCONTRIBUTING.md
)npm run test
The guidelines for how to setup a local dev. environment should be complete: ideally, it should be possible to build and run the tests simply by copy-pasting a series of commands. Any assumptions that are made about the local environment (e.g. npm is already installed) should be documented.
@json-schema-form/angular-schema-form-lead
The text was updated successfully, but these errors were encountered: