Skip to content

Commit

Permalink
docs: add note to contributing re: extensions
Browse files Browse the repository at this point in the history
  • Loading branch information
gadomski committed Feb 15, 2023
1 parent fe5fbf1 commit 7819728
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,16 @@ flag to Git commit commands, as in ``git commit --no-verify``.
.. [#] In rare cases changes to one file might invalidate an unchanged file, such as
when modifying the return type of a function used in another file.
Documentation
^^^^^^^^^^^^^

All new features or changes should include API documentation, in the form of
docstrings. Additionally, if you are updating an extension version, check to
see if that extension is used in the ``examples/`` STAC objects at the top level
of the repository. If so, update the extension version, then re-run
``docs/quickstart.ipynb`` to include the new extension versions in the notebook
cell output.

Benchmarks
^^^^^^^^^^

Expand Down

0 comments on commit 7819728

Please sign in to comment.