The various JSCAD packages and all source code are part of the JSCAD Organization, and is maintained by a group of volunteers. We welcome and encourage anyone to pitch in but please take a moment to read the following guidelines.
-
If you want to submit a bug report please make sure to follow the Reporting Issues guide. Bug reports are accepted as Issues via GitHub.
-
If you want to submit a change or a patch, please read the contents below on how to make changes. New contributions are accepted as Pull Requests via GithHub.
-
We only accept bug reports and pull requests on GitHub.
-
If you have a question about how to use JSCAD, then please start a conversation at the JSCAD User Group. You might find the answer in the JSCAD.org User Guide.
-
If you have a change or new feature in mind, please start a conversation with the Core Developers and start contributing changes.
The contents of this repository contain several packages, all part of the JSCAD project. The JSCAD packages contain both the UI components as well as the library components, and often the JSCAD packages are linked together through dependencies. Therefore, we suggest that you start by creating a fork of this repository. This will keep your changes separate from the fast lane, and make pull requests easier.
You can create a fork via GitHub.
Once forked, clone your copy of the OpenJSCAD.org repository to a local file system.
git clone https://github.com/myusername/OpenJSCAD.org.git
cd OpenJSCAD.org
The next steps require NPM and Node.js. The JSCAD project always develops with the latest LTS releases, so install these versions.
Next, try to run the test suites to verify the installation.
npm install
npm test
This may take some time... relax... have some coffee.
If the tests ran successfully then changes can be made to any package. See the 'packages' directory.
NOTE: All packages and dependencies have been linked together by Lerna. No other magic is required.
If you intend to contribute changes back to JSCAD then please follow these guides.
- follow the JavaScript Standard Style when making changes
- enhance existing test suites or create new tests suites to verify changes
- verify all tests PASS by running
npm testin the local package - verify all tests PASS across all packages by running
npm testin the base directory
Done? Great! Push the changes back to your fork.
git commit changed-file
git add test/new-test-suite.js
git commit test/new-test-suite.js
git push
Finally, you can review your changes via GitHub, and create a pull request.
TIPS for successful pull requests:
- Commit often, and add comments about what changed
- Verify that automated tests pass (see the bottom of the pull request)
WOW! Thanks for the cool code.
The JSCAD Command Line Interface (CLI) can be used for development by executing the CLI manually.
cd packages/cli
node ./cli.js
There are also test suites for the CLI, which can be executed. See *.test.js files for the test suites.
npm test
You can now make changes to any package, and then check the changes by executing the CLI again.
The JSCAD Web UI can be used for development by starting a development webserver manually.
cd packages/web
npm run dev
Now start a browser, and access the URL shown.
You can now make changes to any package. The webserver will automatically detect the change and repackage the distribution. Also, the browser will automaticlly reload the contents from the webserver. Slick!
There are also test suites for the JSCAD Web UI, which can be executed. See *.test.js files for the test suites.
npm test
There are pre-built versions of several JSCAD packages in the 'dist' directory.
You can rebuild these if you need a new version with your changes.
cd package/core
npm run build
A BIG THANKS to all the people who have already contributed to the JSCAD project!
The JSCAD Organization