https://github.com/openclimatefix/.github
Various Community Health Files
https://github.com/openclimatefix/.github
Last synced: over 1 year ago
JSON representation
Various Community Health Files
- Host: GitHub
- URL: https://github.com/openclimatefix/.github
- Owner: openclimatefix
- Created: 2019-10-23T21:41:10.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-02-21T11:59:01.000Z (over 1 year ago)
- Last Synced: 2025-02-21T12:19:52.663Z (over 1 year ago)
- Homepage:
- Size: 234 KB
- Stars: 1
- Watchers: 3
- Forks: 5
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Funding: FUNDING.yml
Awesome Lists containing this project
README
# .github
Various Community and Code Health Files.
## Issue and PR Templates
Found in `.github/ISSUE_TEMPLATE` and `./PULL_REQUEST_TEMPLATE.md` respectively. These files are used across the organisation as [issue templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests).
## Organisation Profile README
Can be found in `.profile/README.md` and is rendered by GitHub on the [OCF organisation page](https://github.com/openclimatefix/).
## Reusable Workflows
To reduce duplication, we offer a set of reusable workflows that are used across most of our repositories. The following workflows can be found in `.github/workflows/`:
- `python-lint`: Runs `ruff`, and `black`
- `python-test`: Runs `pytest` and `pydoctest`
- `python-release`: Runs a release script
You can use these workflows in any other workflow using the syntax `{owner}/{repo}/{path}/{filename}@{ref}`. For example:
```yaml
name: Lint Python
on: [push]
jobs:
call-run-python-linters:
uses: openclimatefix/.github/.github/workflows/python-lint.yml@main
```
You can [learn more about reusable workflows in the GitHub docs](https://docs.github.com/en/actions/learn-github-actions/reusing-workflows).