|
| 1 | +# Our Repositories |
| 2 | + |
| 3 | +:::{todo} |
| 4 | +Add repositories from the pyOpenSci organization. |
| 5 | +::: |
| 6 | + |
| 7 | +## pyOpenSci GitHub Repository Overview |
| 8 | + |
| 9 | +pyOpenSci manages multiple GitHub repositories to support various community |
| 10 | +activities. Below is a description of each core repository. |
| 11 | + |
| 12 | +### [Software-review Repository](https://www.pyopensci.org/software-peer-review/) |
| 13 | + |
| 14 | +The software-review repository is where community package submissions are |
| 15 | +peer-reviewed. All submissions are made through GitHub Issues. [Learn more about |
| 16 | +our peer review process here.](https://www.pyopensci.org/software-peer-review/) |
| 17 | + |
| 18 | +:::{important} |
| 19 | +Important: If a pyOpenSci core member identifies an issue with the review |
| 20 | +submission template, consult both the editorial team and core team before making |
| 21 | +any changes. This template's data are processed by a Python workflow, and even |
| 22 | +small modifications could disrupt the language processing. |
| 23 | +::: |
| 24 | + |
| 25 | + |
| 26 | +### Software-peer-review Guidebook Repository |
| 27 | + |
| 28 | +This repository hosts our [software peer review guide](https://www.pyopensci.org/software-peer-review/), |
| 29 | +which includes instructions and guidelines for authors, editors, the editor in |
| 30 | +chief, and the peer review triage team. It also details our peer review policies, |
| 31 | +partnerships, and the templates used in the review process. |
| 32 | + |
| 33 | +### Python-package-guide Repository |
| 34 | + |
| 35 | +The [python-package-guide repository](https://www.pyopensci.org/python-package-guide/) |
| 36 | +contains our community-developed guidelines and tutorials on Python packaging. |
| 37 | +These resources are beginner-friendly and reflect best practices. |
| 38 | + |
| 39 | +### [pyosMeta Repository](https://github.com/pyOpenSci/pyosMeta) |
| 40 | + |
| 41 | +The pyosMeta repo contains a Python package published on PyPI that tracks our |
| 42 | +package review and contributor data. This data is used in a GitHub action to |
| 43 | +update our website. |
| 44 | + |
| 45 | +### [pyopensci.github.io Repository](https://github.com/pyOpenSci/pyopensci.github.io) |
| 46 | + |
| 47 | +Our website, [pyOpenSci](https://www.pyopensci.org/), is hosted on GitHub and |
| 48 | +uses the Jekyll Minimal Mistakes theme. The python packages page, contributor page and peer review team page are all updated automagically using a |
| 49 | +GitHub action workflow that is supported by the pyosMeta Python package. The workflow runs every other week but can be triggered manually as a **workflow |
| 50 | +dispatch**. |
| 51 | + |
| 52 | +1. **Packages.yml**: Updates the [Python Packages page](https://www.pyopensci.org/python-packages.html) |
| 53 | + by parsing reviews from software-review repository issues. |
| 54 | +2. **Contributors.yml**: Updates the [Our Community page](https://www.pyopensci.org/our-community/index.html) |
| 55 | + by parsing data from all organization repositories. |
| 56 | + |
| 57 | +:::{todo} |
| 58 | +Update the website contributors guide with general CI and specific Jekyll |
| 59 | +information. |
| 60 | +::: |
| 61 | + |
| 62 | +## [Handbook Repository](https://github.com/pyOpenSci/handbook) |
| 63 | + |
| 64 | +The handbook repository hosts content that helps the community navigate our |
| 65 | +online resources and communication channels. |
0 commit comments