Skip to content

Commit

Permalink
chore: reformat lists
Browse files Browse the repository at this point in the history
  • Loading branch information
hollandjg committed Jun 1, 2023
1 parent 7a95689 commit da64835
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/contribute/core.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Contribute to the Core

Core contributions are changes to AutoRA which aren't experimentalists, (synthetic) experiment runners and theorists.
The primary purpose of the core is to provide utilities for:
The primary purpose of the core is to provide utilities for:

- describing experiments (in the [`autora-core` package](https://github.com/autoresearch/autora-core))
- handle workflows for automated experiments
(currently in the [`autora-workflow` package](https://github.com/autoresearch/autora-workflow))

Suggested changes to the core should be submitted as follows, depending on their content:

- For fixes or new features closely associated with existing core functionality: pull request to the existing
core package
- For new features which don't fit into the current module structure, or which are experimental and could lead to
Expand All @@ -17,6 +19,7 @@ Suggested changes to the core should be submitted as follows, depending on their
idea on the [discussions page](https://github.com/orgs/AutoResearch/discussions/categories/ideas).

Core packages should as a minimum:

- Follow standard python coding guidelines including PEP8
- Run under all minor versions of python (e.g. 3.8, 3.9) allowed in
[`autora-core`](https://github.com/autoresearch/autora-core)
Expand Down
3 changes: 3 additions & 0 deletions docs/contribute/module.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Contribute an Experimentalist, Experiment Runner, or Theorist

Each experimentalist, experiment runner or theorist is a "child" package based on either

- the [cookiecutter template (recommended)](https://github.com/AutoResearch/autora-template-cookiecutter), or
- the [unguided template](https://github.com/AutoResearch/autora-template).

Expand Down Expand Up @@ -28,6 +29,7 @@ repository example-contributor/contributor-theorist
Install this in an environment using your chosen package manager. In this example, we use pip and virtualenv.

First, install:

- python: https://www.python.org/downloads/
- virtualenv: https://virtualenv.pypa.io/en/latest/installation.html

Expand Down Expand Up @@ -142,6 +144,7 @@ the right place and renders correctly.

Once everything is working locally, make a new PR on [github.com](https://github.com/autoresearch/autora) with your
changes. Include:

- a description of the changes to the package, and
- a link to your release notes.

Expand Down

0 comments on commit da64835

Please sign in to comment.