diff --git a/docs/contribute/core.md b/docs/contribute/core.md index bfacc6365..0a0cbc887 100644 --- a/docs/contribute/core.md +++ b/docs/contribute/core.md @@ -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 @@ -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) diff --git a/docs/contribute/module.md b/docs/contribute/module.md index 830bc1f18..2477d61d1 100644 --- a/docs/contribute/module.md +++ b/docs/contribute/module.md @@ -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). @@ -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 @@ -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.