Skip to content

Commit

Permalink
Update README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
b1quint committed Sep 14, 2023
1 parent 93caea9 commit 3136372
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,34 @@ summit_testing_analysis

``summit_testing_analysis`` is a package in the `LSST Science Pipelines <https://pipelines.lsst.io>`_.

.. Add a brief (few sentence) description of what this package provides.
It contains code to analyse the performance of Rubin Observatory's components.
Such as M1M3, M2, hexapods, rotator, mount, etc.

Contributing
============

* This repository uses the development guidelines described in
https://developer.lsst.io/.

* The code format should follow the guidelines in
https://developer.lsst.io/python/formatting.html

We use two tools to help with code standards compliance.
They are `black` and `isort`. Use them with the following commands:

.. code-block:: bash
black .
isort .
* This repository is configure with a pre-commit hook. In other words,
it contains an automatic code check before you commit your changes.
Before you can commit your changes, you need to install the pre-commit:

.. code-block:: bash
mamba install -c lsstts ts-pre-commit-config
generate_pre_commit_conf
pre-commit install
pre-commit run --all-files

0 comments on commit 3136372

Please sign in to comment.