Skip to content

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

Closed
donalmurtagh opened this issue Jun 20, 2017 · 3 comments
Closed

Improve contribution docs #901

donalmurtagh opened this issue Jun 20, 2017 · 3 comments

Comments

@donalmurtagh
Copy link
Contributor

donalmurtagh commented Jun 20, 2017

I was trying to setup a local development environment for angular-schema-form. Here's what I did:

  • Cloned all the repos into sibling folders, as described in CONTRIBUTING.md
  • Installed karma (this was not mentioned in CONTRIBUTING.md)
  • Ran npm install (this was not mentioned in CONTRIBUTING.md)
  • Ran bower install (this was not mentioned in CONTRIBUTING.md)
  • Ran 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

@Anthropic
Copy link
Member

@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?

@Anthropic
Copy link
Member

Anthropic commented Jun 24, 2017

@donalmurtagh would this suffice?

How to setup to develop

To 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

@Anthropic Anthropic added this to the 1.0.0 milestone Jun 24, 2017
Anthropic added a commit that referenced this issue Jun 25, 2017
@Anthropic
Copy link
Member

@donalmurtagh please re-open if you have more to add or think there's anything else I should add?

Anthropic added a commit that referenced this issue Jun 25, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants