https://github.com/catalyst-cooperative/catalystcoop-handbook
A readthedocs site containing Catalyst Cooperative policies.
https://github.com/catalyst-cooperative/catalystcoop-handbook
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 7 committers (14.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (14.8%) to scientific vocabulary
Keywords from Contributors
Repository
A readthedocs site containing Catalyst Cooperative policies.
Basic Info
- Host: GitHub
- Owner: catalyst-cooperative
- License: mit
- Language: Python
- Default Branch: main
- Size: 385 KB
Statistics
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 4
- Releases: 0
Metadata Files
README.md
Catalyst Cooperative Handbook
The Catalyst Cooperative Handbook contains the cooperative's bylaws, policies and general information.
This repo allows us to version control and review changes to our policies.
Conda Environment Setup
To edit these docs you need to clone the catalyst-handbook repo and set up a conda environment:
bash
git clone git@github.com:catalyst-cooperative/catalystcoop-handbook.git
We use the mamba/conda package manager to specify and update our development environment.
bash
mamba env create --name handbook --file environment.yml
conda activate handbook
Git Pre-commit Hooks
Git hooks let you automatically run scripts at various points as you manage your source code. “Pre-commit” hook scripts are run when you try to make a new commit. These scripts can review your code and identify bugs, formatting errors, bad coding habits, and other issues before the code gets checked in. This gives you the opportunity to fix those issues before publishing them.
To make sure they are run before you commit any code, you need to enable the pre-commit hooks scripts with this command:
bash
pre-commit install
The scripts that run are configured in the .pre-commit-config.yaml file.
How to make changes
CLI
To make changes to the handbook, edit the relevant markdown documents in the docs/ directory. Once the changes are made
you can build the docs by running:
bash
tox
This command will build the docs and write the html files to docs/_build/. You can view the docs locally by opening the docs/_build/index.html file.
Once the docs are built locally, you can push your changes and open a PR for review. There is a GitHub Action that will build and deploy the changes
to Read the Docs.
UI
If you don't want to make edits with a CLI and code editor, you can use the GitHub UI:
- Click the "Edit" button for the document you want to change:
- Make your changes.
- Select "Create a new branch for this comment and start a pull request", add a commit message and select "Commit changes":
- Tag someone to review your changes.
The changes must be reviewed and approved by someone else to be merged into the main branch.
Owner
- Name: Catalyst Cooperative
- Login: catalyst-cooperative
- Kind: organization
- Email: hello@catalyst.coop
- Location: United States of America
- Website: https://catalyst.coop
- Twitter: CatalystCoop
- Repositories: 82
- Profile: https://github.com/catalyst-cooperative
Catalyst is a small data engineering cooperative working on electricity regulation and climate change.
GitHub Events
Total
- Delete event: 6
- Issue comment event: 2
- Push event: 32
- Pull request review event: 22
- Pull request review comment event: 12
- Pull request event: 23
- Create event: 9
Last Year
- Delete event: 6
- Issue comment event: 2
- Push event: 32
- Pull request review event: 22
- Pull request review comment event: 12
- Pull request event: 23
- Create event: 9
Committers
Last synced: over 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| dependabot[bot] | 4****] | 69 |
| bendnorman | b****9@c****u | 34 |
| pre-commit-ci[bot] | 6****] | 18 |
| Zane Selvans | z****s@c****p | 16 |
| Austen Sharpe | a****e@g****m | 9 |
| Dazhong Xia | j****a@g****m | 1 |
| swinter2011 | s****r@c****p | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 2
- Total pull requests: 120
- Average time to close issues: about 21 hours
- Average time to close pull requests: 16 days
- Total issue authors: 2
- Total pull request authors: 9
- Average comments per issue: 0.0
- Average comments per pull request: 0.5
- Merged pull requests: 88
- Bot issues: 0
- Bot pull requests: 98
Past Year
- Issues: 0
- Pull requests: 7
- Average time to close issues: N/A
- Average time to close pull requests: 7 days
- Issue authors: 0
- Pull request authors: 4
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 5
Top Authors
Issue Authors
- zaneselvans (1)
- bendnorman (1)
Pull Request Authors
- dependabot[bot] (100)
- pre-commit-ci[bot] (21)
- zaneselvans (10)
- bendnorman (7)
- aesharpe (5)
- jdangerx (1)
- swinter2011 (1)
- e-belfer (1)
- danohu (1)
- leetrout (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- ridedott/merge-me-action v2 composite
- tibdex/github-app-token v1 composite
- 8398a7/action-slack v3 composite
- actions/checkout v3 composite
- codecov/codecov-action v3.1.4 composite
- conda-incubator/setup-miniconda v2.2.0 composite
- doc8 >=0.9,<1.2
- furo >=2022.4.7
- mdformat *
- mdformat-myst *
- myst-parser >=0.18,<2.1
- pre-commit >=2.9,<3.4
- pydocstyle >=5.1,<6.4
- sphinx >=4,
- sphinx-autoapi >=1.8,<2.2
- sphinx-issues >=1.2,<3.1
- tox >=3.20,<4.7