+ + +
+ ISIS Documentation
+ ++ + +
+ + Contributor Explore in Detail +++ Creating and maintaining quality tools is not simple. ISIS contributors have + worked hard to create accurate references and guides to support future + contributions. If you encounter a specific case that could help future + contributors, feel free to submit documentation for this page. + ++ On this page you will find detailed references and specialized guides for contributing to ISIS. + ++ + |
+ + Home + | +
+
ISIS API Reference
++ The ISIS API reference is particularly useful if you are working on an application + or interested in using the ISIS library as a dependency. +
+| + + astrodiscuss + | ++ Ask or answer questions on out community discussion board. + | +
|---|---|
| + + GitHub Issues + | ++ Comment on bug reports or feature requests from other users. + | +
| + + Requests for Comment + | ++ Provide feedback on major changes proposed for ISIS. + | +
| + + ISIS Technical Committee + | ++ Get involved in project governance. + | +
+
XML Schemas
++ The interface for ISIS applications and much of the ISIS documentation (including this + very page) are generated from XML files. These schemas are a helpful reference if you + are creating a new application, modifying application arguments, or writing documentation. +
+| + + Downloading the Source Code + | ++ How to pull the source code from GitHub. + | +
|---|---|
| + + Dependency Management + | ++ How to download the dependencies required to build ISIS. + | +
| + + Building + | ++ How to build ISIS once you have the source code and dependencies downloaded. + | +
| + + Running the Test Suite + | ++ How to run the ISIS test suite once ISIS is built. + | +
+
Documentation Guides
++ If you're not familiar with working on the ISIS documentation, + these guides can help get you started. +
+| + + Basic ISIS3 Programming + | ++ hese exercises will walk you through the basics of ISIS applications. + | +
|---|---|
| + + Advanced ISIS Programming Exercises + | ++ These exercises give you the chance to explore more yourself and interact with more + complex components of the ISIS API. + | +
+
Testing Guides
++ Testing is a crucial component of creating sustainable software and a requirement for all + code contributions to ISIS. These guides will help you run and modify the ISIS test suite. +
+| + + Adding a New Feature + | ++ This document will walk you through what's needed when adding a new feature to ISIS. + If there is something you think is missing in ISIS this will walk you through the + steps needed to add it. + | +
|---|---|
| + + Modifying an Existing Feature + | ++ Modifying an existing feature is slightly more complex than adding a new feature to ISIS. + This document will walk you through what is different when you are building from an + existing feature instead of something new. + | +
+
Maintainer Guides
++ These resources are useful for maintainers and outline the processes that + support the broader user and contributor community. +
+| + + Adding a New Feature + | ++ This document will walk you through what's needed when adding a new feature to ISIS. + If there is something you think is missing in ISIS this will walk you through the + steps needed to add it. + | +
|---|---|
| + + Modifying an Existing Feature + | ++ Modifying an existing feature is slightly more complex than adding a new feature to ISIS. + This document will walk you through what is different when you are building from an + existing feature instead of something new. + | +