generated from AFg6K7h4fhy2/AFg6K7h4fhy2-Template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit b1a72fc
Showing
12 changed files
with
867 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# For any changes to any facet of this repository reference: | ||
* @AFg6K7h4fhy2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
name: Long Form Issue Template | ||
about: An extended issue, containing a goal and context, tasks and resources. | ||
title: "" | ||
labels: ["long form issue"] | ||
assignees: "" | ||
--- | ||
|
||
DELETE_ONCE_ISSUE_IS_CREATED: This template serves as rough scheme for the content of issues in the author's repositories. Strict adherence to this template is not necessary; rather, the template acts as a guideline. | ||
|
||
DELETE_ONCE_ISSUE_IS_CREATED: Standards of development have not yet been made, but please keep an eye out for them, given that they'll likely be created by June 2024. Not that everything below contained in `[ ]` ought to be replaced with your issue comments. | ||
|
||
## Goal | ||
|
||
[several sentences on the desired changes] | ||
|
||
## Context | ||
|
||
[one to several paragraphs describing why the change is superior to what already exists (arguments for this change) and what precedent exists for the desired changes] | ||
|
||
## Tasks | ||
|
||
[modular tasks that will need to be completed as part of the issue's goals; please include at least one task, see example below] | ||
|
||
- [ ] E.g. modify file X to include a paragraph on A, B, and or C. | ||
|
||
## Not Covered | ||
|
||
- [changes that are beyond the scope of this issue] | ||
|
||
## Resources & Links | ||
|
||
- [links (in list format) to useful resources, including papers and repositories, and other issues, PRs, discussions, etc...] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
name: pre-commit | ||
description: run pre-commit | ||
inputs: | ||
extra_args: | ||
description: options to pass to pre-commit run | ||
required: false | ||
default: '--all-files' | ||
runs: | ||
using: composite | ||
steps: | ||
- run: python -m pip install pre-commit | ||
shell: bash | ||
- run: python -m pip freeze --local | ||
shell: bash | ||
- run: pre-commit run --show-diff-on-failure --color=always ${{ inputs.extra_args }} | ||
shell: bash |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
name: pre-commit | ||
|
||
on: | ||
pull_request: | ||
push: | ||
branches: [main] | ||
|
||
jobs: | ||
pre-commit: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: actions/setup-python@v5 | ||
- uses: ./.github/actions/pre-commit |
Oops, something went wrong.