Skip to content

Commit 0966f91

Browse files
author
Claude
committed
Merge branch 'feature/conform' into develop
2 parents 817de3b + 78e3d06 commit 0966f91

File tree

6 files changed

+161
-0
lines changed

6 files changed

+161
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Bug Report
2+
description: Report an issue or a bug.
3+
title: "[BUG]: << Please use a comprehensive title... >>"
4+
labels: [Defect]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
Thank you for taking the time to file a bug report. Before continuing, please take some time to check the existing [issues](https://github.com/colour-science/colour-dash/issues).
11+
The issue could already be fixed in the [develop](https://github.com/colour-science/colour-dash) branch. If you have an installation problem, the [installation guide](https://www.colour-science.org/installation-guide/) describes the recommended process.
12+
13+
- type: textarea
14+
attributes:
15+
label: "Description"
16+
description: >
17+
Please describe the issue in a few short sentences.
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
attributes:
23+
label: "Code for Reproduction"
24+
description: >
25+
If possible, please provide a minimum self-contained example reproducing the issue.
26+
placeholder: |
27+
<< Your code here... >>
28+
render: python
29+
30+
- type: textarea
31+
attributes:
32+
label: "Exception Message"
33+
description: >
34+
If any, please paste the *full* exception message.
35+
placeholder: |
36+
<< Full traceback starting from `Traceback (most recent call last):`... >>
37+
render: shell
38+
39+
- type: textarea
40+
attributes:
41+
label: "Environment Information"
42+
description: If possible, please paste the output from `import colour; colour.utilities.describe_environment()`.
43+
render: shell

‎.github/ISSUE_TEMPLATE/documentation-improvement.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Documentation Improvement
2+
description: Report a documentation improvement.
3+
title: "[DOCUMENTATION]: << Please use a comprehensive title... >>"
4+
labels: [Documentation]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
Thank you for taking the time to file a documentation improvement report. Before continuing, please take some time to check the existing [issues](https://github.com/colour-science/colour-dash/issues).
11+
12+
- type: input
13+
attributes:
14+
label: Documentation Link
15+
description: >
16+
Please link to any documentation or examples that you are referencing. Suggested improvements should be based on the [development version of the documentation](https://colour-dash.readthedocs.io/en/develop/).
17+
placeholder: >
18+
<< https://colour-dash.readthedocs.io/en/develop/... >>
19+
validations:
20+
required: true
21+
22+
- type: textarea
23+
attributes:
24+
label: Description
25+
description: >
26+
Please describe what is missing, unclear or incorrect.
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
attributes:
32+
label: Suggested Improvement
33+
description: >
34+
Please describe how the documentation could be improved.
35+
36+
- type: textarea
37+
attributes:
38+
label: "Environment Information"
39+
description: If possible, please paste the output from `import colour; colour.utilities.describe_environment()`.
40+
render: shell

‎.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: Feature Request
2+
description: Suggest a new feature to implement.
3+
title: "[FEATURE]: << Please use a comprehensive title... >>"
4+
labels: [Feature]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
Thank you for taking the time to file a feature request. Before continuing, please take some time to check the existing [issues](https://github.com/colour-science/colour-dash/issues).
11+
12+
- type: textarea
13+
attributes:
14+
label: "Description"
15+
description: >
16+
Please describe the new feature in a few short sentences.
17+
validations:
18+
required: true

‎.github/ISSUE_TEMPLATE/question.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Question
2+
description: Ask a question.
3+
title: "[DISCUSSION]: << Please use a comprehensive title... >>"
4+
labels: [Discussion]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: Thank you for taking the time to ask a question or discuss. Before continuing, we would be glad if you were to start this discussion in the dedicated [discussions](https://github.com/colour-science/colour-dash/discussions) area.
10+
11+
- type: textarea
12+
attributes:
13+
label: "Question"
14+
description: >
15+
If you are still here, please consider using the dedicated [discussions](https://github.com/colour-science/colour-dash/discussions) area.
16+
placeholder: >
17+
<< The discussions area is this way: https://github.com/colour-science/colour-dash/discussions... >>

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!--
2+
Thank you for taking the time to create this pull request. If it is the first
3+
time you are contributing to a colour-science repository, a contributing guide
4+
is available to guide the process: https://www.colour-science.org/contributing/.
5+
-->
6+
7+
# Summary
8+
9+
<!-- Please write a summary describing the changes that this PR implements. -->
10+
11+
# Preflight
12+
13+
<!-- Please mark any checkboxes that do not apply to this pull request as [N/A]. -->
14+
15+
**Code Style and Quality**
16+
17+
- [ ] Unit tests have been implemented and passed.
18+
- [ ] Pyright static checking has been run and passed.
19+
- [ ] Pre-commit hooks have been run and passed.
20+
21+
<!-- The unit tests can be invoked with `uv run invoke tests` -->
22+
<!-- Pyright can be started with `uv run pyright --threads --skipunannotated` -->
23+
24+
**Documentation**
25+
26+
- [ ] New features are documented along with examples if relevant.
27+
- [ ] The documentation is [Sphinx](https://www.sphinx-doc.org/en/master/) and [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) compliant.
28+
29+
<!--
30+
Thank you again!
31+
-->

‎.github/funding.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: # Replace with a single Patreon username
5+
open_collective: colour-science # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

0 commit comments

Comments
 (0)