Skip to content

Commit

Permalink
Merge pull request #475 from AutoResearch/docs/elaborate-on-PR-proces…
Browse files Browse the repository at this point in the history
…s-for-contributions

Elaborate on PR process for contributions
  • Loading branch information
benwandrew authored Jun 23, 2023
2 parents 2ebfe45 + b173aca commit fec3fa9
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/contribute/modules/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,20 +81,22 @@ Once you've published your module, you should take some time to celebrate and an

## Incorporating your module into the `autora` parent package

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.
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.
The following demonstrates how to add a package published under `autora-theorist-example` in PyPI in the GitHub
repository `example-contributor/contributor-theorist`

!!! success
In order for your package to be included in the parent package, it must
- include basic documentation in ``docs/index.md``
- include a basic python notebook exposing how to use the module in ``docs/Basic Usage.ipynb``
- include basic tests in ``tests/``
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/``
- be published via PyPI or Conda
- be compatible with the current version of the parent package
- follow standard python coding guidelines including PEP8

The following demonstrates how to add a package published under autora-theorist-example in PyPI in the GitHub
repository example-contributor/contributor-theorist

### Install the "parent" package in development mode

Install this in an environment using your chosen package manager. In this example, we use pip and virtualenv.
Expand Down Expand Up @@ -126,6 +128,9 @@ mkdocs serve

... then viewing the documentation using the link in your terminal.

### Create a new branch of the parent package

Once you've successfully installed the parent package in development mode, you can begin the process of adding your contribution by creating a new branch off of the `main` branch. You should name your branch according to the name of your contribution. In the example we're using here, the branch would be called `feat/contributor-theorist`. After creating your branch, you can start making the modifications specified below.

### Add the package as optional dependency

Expand Down

0 comments on commit fec3fa9

Please sign in to comment.