Skip to content

Commit 10c8966

Browse files
galenlynchdyf
andauthored
docs/maintenance-mode (#2772)
Make it clear that this package is in maintenance mode. Co-authored-by: David Feng <dyf@users.noreply.github.com>
1 parent 920f18e commit 10c8966

File tree

9 files changed

+438
-196
lines changed

9 files changed

+438
-196
lines changed
Lines changed: 45 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,56 @@
11
---
22
name: Bug report
3-
about: Report a problem
4-
title: ''
5-
labels: bug
6-
assignees: ''
7-
3+
about: Report a reproducible problem in AllenSDK
4+
title: "[Bug]: "
5+
labels: ["bug"]
6+
assignees: ""
87
---
98

10-
**Describe the bug**
11-
A summary of what the bug is.
9+
<!--
10+
Thanks for reporting this issue.
11+
12+
AllenSDK is in selective maintenance mode:
13+
- We prioritize bug fixes, security fixes, docs/tests, and targeted compatibility updates.
14+
- Some issues may be closed as "not planned" based on scope and maintainer capacity.
15+
-->
16+
17+
## Describe the bug
18+
19+
A clear and concise description of the problem.
20+
21+
## To reproduce
22+
23+
Please provide a minimal, reproducible example.
1224

13-
**To Reproduce**
14-
Steps to reproduce the behavior. Please include all relevant code!
25+
1.
26+
2.
27+
3.
28+
29+
Include code, command line calls, config, and relevant input data details where possible.
30+
31+
## Expected behavior
1532

16-
**Expected behavior**
1733
What you expected to happen.
1834

19-
**Actual Behavior**
20-
What actually happened. If the bug produced an error message or incorrect values, please include them here!
35+
## Actual behavior
36+
37+
What actually happened.
38+
Please include full error messages/tracebacks and unexpected outputs.
39+
40+
## Environment
41+
42+
- OS and version:
43+
- Python version:
44+
- AllenSDK version:
45+
- Install method (pip/conda/source):
46+
- Execution context (local/CI/notebook/cluster):
47+
- Any pinned dependencies or unusual environment details:
48+
49+
## Additional context
2150

22-
**Environment (please complete the following information):**
23-
- OS & version: [e.g. Ubuntu 18.04]
24-
- Python version [e.g. 3.7]
25-
- AllenSDK version [e.g. v1.0.0]
51+
Any other context, screenshots, logs, links to related issues, or workarounds tried.
2652

27-
**Additional context**
28-
Add any other context about the problem here.
53+
## Are you willing to submit a fix?
2954

30-
**Do you want to work on this issue?**
31-
Are you willing and able to fix this bug? If so, let us know here (and see [the guide](https://github.com/AllenInstitute/AllenSDK/blob/master/CONTRIBUTING.md)). Thank you!
55+
- [ ] Yes, I can work on a PR for this
56+
- [ ] No, but I can help test a proposed fix

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Allen Brain Map Community Forum
4+
url: https://community.brain-map.org
5+
about: Ask general Allen Brain Map or data/tool questions here.
6+
- name: AllenSDK documentation
7+
url: https://allensdk.readthedocs.io/en/latest/
8+
about: Check install, API, and usage docs before filing an issue.
9+
- name: Support guide
10+
url: https://github.com/AllenInstitute/AllenSDK/blob/master/SUPPORT.md
11+
about: Where to ask questions, report bugs, and request features.
Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,42 @@
11
---
22
name: Feature request
3-
about: Suggest a new feature
4-
title: ''
5-
labels: enhancement
6-
assignees: ''
7-
3+
about: Propose a new capability for AllenSDK
4+
title: "[Feature]: "
5+
labels: ["enhancement"]
6+
assignees: ""
87
---
98

10-
**Describe the use case that is addressed by this feature.**
11-
The problem that this feature would solve.
9+
<!--
10+
Thanks for the suggestion.
11+
12+
AllenSDK is in selective maintenance mode:
13+
- Maintainers are not planning new feature development.
14+
- Community feature PRs are welcome.
15+
- Requests or PRs may be closed as "not planned" if maintenance burden is too high.
16+
-->
17+
18+
## Problem / use case
19+
20+
Describe the user problem this feature would solve and who benefits.
21+
22+
## Proposed solution
23+
24+
Describe what you want to happen.
25+
26+
## Alternatives considered
27+
28+
Describe alternative approaches, including why they are not sufficient.
29+
30+
## Maintenance considerations
31+
32+
Briefly describe any backward compatibility, dependency, or long-term maintenance concerns.
1233

13-
**Describe the solution you'd like**
14-
What you want to happen.
34+
## Additional context
1535

16-
**Describe alternatives you've considered**
17-
Any alternative solutions or features you've considered.
36+
Add examples, mock APIs, references, or related issues/PRs.
1837

19-
**Additional context**
20-
Add any other information about the feature request here.
38+
## Implementation interest
2139

22-
**Do you want to work on this issue?**
23-
Are you willing and able to work on this feature? If so, let us know here (and see [the guide](https://github.com/AllenInstitute/AllenSDK/blob/master/CONTRIBUTING.md)). Thank you!
40+
- [ ] I can work on a PR
41+
- [ ] I can help with design/review/testing
42+
- [ ] I cannot contribute implementation right now

.github/ISSUE_TEMPLATE/question.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,39 @@
11
---
22
name: Question
3-
about: Question about the AllenSDK
4-
title: ''
5-
labels: 'question'
6-
assignees: ''
7-
3+
about: Ask a usage question about AllenSDK
4+
title: "[Question]: "
5+
labels: ["question"]
6+
assignees: ""
87
---
8+
9+
<!--
10+
For general Allen Brain Map / data-tool questions, please use the community forum:
11+
https://community.brain-map.org
12+
13+
Use this template for AllenSDK-specific usage questions.
14+
For broad roadmap/new-feature discussions, please open a Feature request issue instead.
15+
-->
16+
17+
## Question
18+
19+
What are you trying to do, and what is your specific question?
20+
21+
## What you tried
22+
23+
Please include code snippets, commands, and links to docs/examples you already checked.
24+
25+
## Minimal example (recommended)
26+
27+
Provide a small reproducible snippet or pseudo-code showing the issue/question context.
28+
29+
## Environment
30+
31+
- OS and version:
32+
- Python version:
33+
- AllenSDK version:
34+
- Install method (pip/conda/source):
35+
- Execution context (local/CI/notebook/cluster):
36+
37+
## Additional context
38+
39+
Anything else that may help (tracebacks, screenshots, data modality, related issues/PRs).

.github/MAINTAINER_RESPONSES.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
### Not planned (feature out of scope)
2+
3+
Thanks for the proposal. This could be useful, but this project is in
4+
selective maintenance mode and maintainers are not taking on new feature
5+
development right now.
6+
7+
Given current scope/capacity, we're closing as **not planned**.
8+
9+
If you'd like to contribute this, we're open to reviewing a focused PR with
10+
tests and a clear long-term maintenance story.
11+
12+
---
13+
14+
### Not planned (compatibility cost too high)
15+
16+
Thanks for the report. We confirmed this compatibility gap, but addressing it
17+
would require substantial refactoring and ongoing maintenance beyond current
18+
project scope/capacity.
19+
20+
For that reason, we're closing as **not planned**.
21+
22+
If someone wants to propose a minimal, low-risk patch with tests, we can reconsider.
23+
24+
---
25+
26+
### Needs contributor follow-through
27+
28+
Thanks -- we're open to this direction, but we can't prioritize implementation
29+
right now.
30+
31+
Marking this as **help wanted**. A PR is welcome.
32+
33+
---
34+
35+
### Stale / inactive
36+
37+
This issue has had no activity for an extended period. Closing for now to keep
38+
the tracker focused.
39+
40+
If this is still relevant, feel free to reopen with updated context or a linked PR.

0 commit comments

Comments
 (0)