Skip to content

Commit

Permalink
Add suggested information to README.rst.
Browse files Browse the repository at this point in the history
Pointing to how to build the package and giving a maintenance contact will assist in usage and maintenance.
  • Loading branch information
ktlim authored and timj committed Apr 5, 2024
1 parent b02da08 commit fd033de
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions project_templates/stack_package/example/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,7 @@ example
``example`` is a package in the `LSST Science Pipelines <https://pipelines.lsst.io>`_.

.. Add a brief (few sentence) description of what this package provides.
Follow `these instructions <https://pipelines.lsst.io/install/package-development.html>`_ to build this package.

Maintenance contact: {First} {Last} ({GitHub username}).

0 comments on commit fd033de

Please sign in to comment.