https://github.com/spacetelescope/stsci-package-template
A package template for STScI Open Source software projects
https://github.com/spacetelescope/stsci-package-template
python sphinx-documentation stsci template-project
Last synced: 4 months ago
JSON representation
A package template for STScI Open Source software projects
- Host: GitHub
- URL: https://github.com/spacetelescope/stsci-package-template
- Owner: spacetelescope
- License: bsd-3-clause
- Created: 2016-11-03T20:57:03.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2025-10-08T18:21:30.000Z (9 months ago)
- Last Synced: 2025-10-10T20:25:36.108Z (9 months ago)
- Topics: python, sphinx-documentation, stsci, template-project
- Language: Python
- Homepage: https://stsci-package-template.readthedocs.io
- Size: 614 KB
- Stars: 3
- Watchers: 7
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE.rst
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION
Awesome Lists containing this project
README
STScI Package Template
======================
.. image:: https://readthedocs.org/projects/stsci-package-template/badge/?version=latest
:target: https://stsci-package-template.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://github.com/spacetelescope/stsci-package-template/workflows/CI/badge.svg
:target: https://github.com/spacetelescope/stsci-package-template/actions
:alt: GitHub Actions CI Status
.. image:: https://codecov.io/gh/spacetelescope/stsci-package-template/branch/main/graph/badge.svg
:target: https://codecov.io/gh/spacetelescope/stsci-package-template
:alt: Coverage Status
.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
:target: http://www.astropy.org
:alt: Powered by Astropy Badge
To use this package template, see instructions for
`GitHub's creating a repository from a template `_.
After you have created your new repository from this template,
please go through all the files in your new repository carefully
and customize it as you see fit. Please also refer to
`STScI style guides `_.
License
-------
See `LICENSE.rst` for more information.
Contributing
------------
We love contributions! `packagename` is open source,
built on open source, and we'd love to have you hang out in our community.
**Imposter syndrome disclaimer**: We want your help. No, really.
There may be a little voice inside your head that is telling you that you're not
ready to be an open source contributor; that your skills aren't nearly good
enough to contribute. What could you possibly offer a project like this one?
We assure you - the little voice in your head is wrong. If you can write code at
all, you can contribute code to open source. Contributing to open source
projects is a fantastic way to advance one's coding skills. Writing perfect code
isn't the measure of a good developer (that would disqualify all of us!); it's
trying to create something, making mistakes, and learning from those
mistakes. That's how we all improve, and we are happy to help others learn.
Being an open source contributor doesn't just mean writing code, either. You can
help out by writing documentation, tests, or even giving feedback about the
project (and yes - that includes giving feedback about the contribution
process). Some of these contributions may be the most valuable to the project as
a whole, because you're coming to the project with fresh eyes, so you can see
the errors and assumptions that seasoned contributors have glossed over.
*Note:* This disclaimer was originally written by
`Adrienne Lowe `_ for a
`PyCon talk `_, and was adapted by
packagename based on its use in the README file for the
`MetPy project `_.