/ins-jwst-community-software

Standards for JWST community tools developed and maintained by the Instruments Division

BSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

INS JWST Community Software

This repository is a part of an initiative to have all software tools for the JWST user community that are developed/maintained by the Instruments Division (INS) meet accepted software standards. This includes the software being robust, maintainable, documented, and supported. The contents of this repository aims to describe these standards for the INS software tools and encourage a common approach across projects.

This work is managed by the INS Software Development Leads for this project Matthew Bourque @bourque and Shannon Osborne @shanosborne

Contents

The software standards have been split into "tier 1" and "tier 2" goals.

Tier 1 standards:

Tier 2 standards:

Contributing

If you want to suggest changes to this content do the following:

  1. Create a fork of this repository
  2. Make a local clone of your fork
  3. Ensure your personal fork is pointing upstream properly
  4. Create a branch on that personal fork
  5. Make your changes
  6. Push that branch to your personal GitHub repository (i.e. origin)
  7. On the spacetelescope repository, create a pull request
  8. Assign a reviewer (either @bourque or @shanosborne)
  9. Iterate with the reviewer over any needed changes until the reviewer accepts and merges your branch
  10. Delete your local copy of your branch

Questions?

Any questions about this effort may be directed to bourque@stsci.edu and sosborne@stsci.edu