Skip to content

Commit

Permalink
docs: update formatting of success block with bulletpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
hollandjg committed Jun 12, 2024
1 parent 9e3c6b3 commit 292aa14
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/contribute/modules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,9 @@ Once you've published your module, you should take some time to celebrate and an
Once your package is working and published, you can **make a pull request** on [`autora`](https://github.com/autoresearch/autora) to have it vetted and added to the "parent" package. Note, if you are not a member of the AutoResearch organization on GitHub, you will need to create a fork of the repository for the parent package and submit your pull request via that fork. If you are a member, you can create a pull request from a branch created directly from the parent package repository. Steps for creating a new branch to add your module are specified below.

!!! success

In order for your package to be included in the parent package, it must meet the following criteria:

* have basic documentation in ``docs/index.md``
* have a basic python notebook exposing how to use the module in ``docs/Basic Usage.ipynb``
* have basic tests in ``tests/``
Expand Down

0 comments on commit 292aa14

Please sign in to comment.