-
Notifications
You must be signed in to change notification settings - Fork 31
How to Contribute
Interested in contributing? We'd love to have your help! This page outlines various ways from contributing to the project. Contributions can take a variety of forms, and we'll use this page to outline a few best practices for contributing to Spectacles
This is the easiest way to contribute to Spectacles - use our issues page to tell us what you think! We use issues to keep track of ideas, discuss new functionality before building it out, and for using all of github's cute little icons like these: 🌊 🐙 ⛵
Find a bug??? Please let us know! Use the issues page and do your best to describe what went wrong.
If you'd like to contribute to the Spectacles Viewer's source code, you should fork the repo, commit your changes, and submit a pull request back to this repo. If that all sounds like nonsense to you, give this a quick read. If you want to get involved but are not quite sure how to get started or what to build, have a look at our help-wanted issues and see if anything interests you. Feel free to ask questions inside of issues - that's what they are there for.
The project's source code is in the root of the repo, so that the client side app can run cleanly at this repo's github.io page. The SPECTACLES.js library itself is in the /js directory, along with a file called APP_INIT.js which contains the jQuery $(document).ready() callback (which initializes the Spectacles viewer).
We use both Visual Studio and Webstorm for development, and are careful to keep any IDE config files out of the project's source. If you are using a different IDE, please be sure that you do the same, and feel free to edit our .gitignore file as needed.