From 03f4f6dc66d522459f4eb8124fa9650798ffd520 Mon Sep 17 00:00:00 2001 From: benwandrew Date: Thu, 22 Jun 2023 16:12:58 +0000 Subject: [PATCH 1/7] docs: update language --- docs/contribute/modules/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/contribute/modules/index.md b/docs/contribute/modules/index.md index adb38c962..774af50e1 100644 --- a/docs/contribute/modules/index.md +++ b/docs/contribute/modules/index.md @@ -87,10 +87,10 @@ The following demonstrates how to add a package published under autora-theorist- 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: + - 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 From 0cf721fe9789f1f88666183f28935e38cd53b061 Mon Sep 17 00:00:00 2001 From: benwandrew Date: Thu, 22 Jun 2023 16:18:23 +0000 Subject: [PATCH 2/7] docs: reorder paragraph --- docs/contribute/modules/index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/contribute/modules/index.md b/docs/contribute/modules/index.md index 774af50e1..24c206b0f 100644 --- a/docs/contribute/modules/index.md +++ b/docs/contribute/modules/index.md @@ -83,8 +83,6 @@ 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. -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: @@ -95,6 +93,9 @@ repository example-contributor/contributor-theorist - 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. From ea4422b20b39797c6855bef3f5994b9306bfd78a Mon Sep 17 00:00:00 2001 From: benwandrew Date: Thu, 22 Jun 2023 16:29:31 +0000 Subject: [PATCH 3/7] docs: specify creation of new branch --- docs/contribute/modules/index.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/contribute/modules/index.md b/docs/contribute/modules/index.md index 24c206b0f..04b61f53a 100644 --- a/docs/contribute/modules/index.md +++ b/docs/contribute/modules/index.md @@ -127,6 +127,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`. ### Add the package as optional dependency From 090e4662ae47510cf782b13122f93d9781236d84 Mon Sep 17 00:00:00 2001 From: benwandrew Date: Thu, 22 Jun 2023 20:28:21 +0000 Subject: [PATCH 4/7] docs: more description --- docs/contribute/modules/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contribute/modules/index.md b/docs/contribute/modules/index.md index 04b61f53a..7e41daf23 100644 --- a/docs/contribute/modules/index.md +++ b/docs/contribute/modules/index.md @@ -129,7 +129,7 @@ mkdocs serve ### 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`. +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 From fd6bbfe3bf02113d9c3f0ffa57f857bc8bac97d5 Mon Sep 17 00:00:00 2001 From: benwandrew Date: Thu, 22 Jun 2023 20:32:35 +0000 Subject: [PATCH 5/7] docs: language --- docs/contribute/modules/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contribute/modules/index.md b/docs/contribute/modules/index.md index 7e41daf23..ebf15634f 100644 --- a/docs/contribute/modules/index.md +++ b/docs/contribute/modules/index.md @@ -85,7 +85,7 @@ 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. !!! success - In order for your package to be included in the parent package, it must: + 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/`` From 3ca3ab6ccc4b356c98e78b9451d6bc5b8f5efb8a Mon Sep 17 00:00:00 2001 From: benwandrew Date: Thu, 22 Jun 2023 20:08:11 -0400 Subject: [PATCH 6/7] docs: differentiate members vs non-members of AutoResearch in creating a contribution PR --- docs/contribute/modules/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contribute/modules/index.md b/docs/contribute/modules/index.md index ebf15634f..6c6f6e6a5 100644 --- a/docs/contribute/modules/index.md +++ b/docs/contribute/modules/index.md @@ -82,7 +82,7 @@ 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. +[`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 a branch on that fork. If you are a member, you can create a pull request on a branch created directly from the parent package repository. Either way, 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: From 3e752ff43f7f1526e095f784e07bdc8ab9bb332a Mon Sep 17 00:00:00 2001 From: benwandrew Date: Fri, 23 Jun 2023 06:03:26 -0400 Subject: [PATCH 7/7] Update docs/contribute/modules/index.md Co-authored-by: Younes Strittmatter --- docs/contribute/modules/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contribute/modules/index.md b/docs/contribute/modules/index.md index 6c6f6e6a5..d4aea8545 100644 --- a/docs/contribute/modules/index.md +++ b/docs/contribute/modules/index.md @@ -82,7 +82,7 @@ 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. 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 a branch on that fork. If you are a member, you can create a pull request on a branch created directly from the parent package repository. Either way, steps for creating a new branch to add your module are specified below. +[`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: