Skip to content

Commit

Permalink
Improve open-source contribution infrastructure
Browse files Browse the repository at this point in the history
Fixes #71
  • Loading branch information
kallewesterling committed Feb 12, 2024
1 parent 0139be9 commit d210d4e
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ The easiest way to get involved with the active development of AutoEmulate is to

## How to Contribute

We welcome contributions of all kinds, be it code, documentation, or community engagement. We encourage you to read through the following sections to learn more about how you can contribute to
We welcome contributions of all kinds, be it code, documentation, or community engagement. We encourage you to read through the following sections to learn more about how you can contribute to the package.

We are always interested in adding more sampling/experimental design strategies (see https://github.com/alan-turing-institute/autoemulate/issues/6) and more simulation data packages (see https://github.com/alan-turing-institute/autoemulate/issues/4).

## How to Submit Changes

Expand Down
6 changes: 6 additions & 0 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,17 @@ chapters:
# - file: getting-started/data_requirements
- file: getting-started/installation
- file: getting-started/quickstart
- file: getting-started/choosing-design

- file: tutorials/index
sections:
- file: tutorials/01_start

- file: community/index
sections:
- file: community/contributing
- file: community/code-of-conduct

- file: reference/index
sections:
- file: reference/compare
Expand Down
2 changes: 2 additions & 0 deletions docs/community/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
```{include} ../../CODE_OF_CONDUCT.md
```
2 changes: 2 additions & 0 deletions docs/community/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
```{include} ../../CONTRIBUTING.md
```
5 changes: 5 additions & 0 deletions docs/community/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Community

The AutoEmulate community is a group of users and contributors who are interested in the development of AutoEmulate. The community is open to anyone who is interested in AutoEmulate. The community is a place to ask questions, discuss ideas, and share your work.

We are currently building out our community infrastructure, but meanwhile we are very much welcoming contributions to the package. To get started, please read the [Contributing Guide](./contributing.md).
5 changes: 5 additions & 0 deletions docs/getting-started/choosing-design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Set up your sampling/experimental design

<!--
To add here (see #6): the user currently has the responsibility for sampling / experimental design, and autoemulate only does the model fitting
-->

0 comments on commit d210d4e

Please sign in to comment.