Skip to content

Commit 1eb308c

Browse files
authored
chore: add feature request template, update community docs (#164)
1 parent b1124e8 commit 1eb308c

File tree

7 files changed

+92
-10
lines changed

7 files changed

+92
-10
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: "Bug report"
22
description: "Report a bug to help us improve Pixel Agents."
33
title: "[Bug]: "
4-
labels: ["bug"]
4+
labels: ["type: bug"]
55
body:
66
- type: textarea
77
id: description

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: "Feature request"
4-
url: "https://github.com/pablodelucca/pixel-agents/discussions/categories/ideas"
5-
about: "Suggest new features or ideas in Discussions."
6-
- name: "Question"
3+
- name: "Question / Help"
74
url: "https://github.com/pablodelucca/pixel-agents/discussions/categories/q-a"
85
about: "Ask questions and get help in Discussions."
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
name: "Feature request"
2+
description: "Suggest a new feature, idea, or improvement for Pixel Agents."
3+
title: "[Feature]: "
4+
labels: ["type: feature"]
5+
body:
6+
- type: checkboxes
7+
id: checks
8+
attributes:
9+
label: "Pre-flight checklist"
10+
options:
11+
- label: "I have searched existing issues and this is not a duplicate"
12+
required: true
13+
14+
- type: textarea
15+
id: problem
16+
attributes:
17+
label: "Problem or motivation"
18+
description: "What problem does this solve, or what need does it address? A clear problem statement helps us prioritize."
19+
placeholder: "e.g., When I have many agents open, I can't tell which terminal each character is connected to."
20+
validations:
21+
required: true
22+
23+
- type: textarea
24+
id: solution
25+
attributes:
26+
label: "Proposed solution"
27+
description: "How should it work? Describe the behavior, UI, or API you envision."
28+
placeholder: "e.g., Show the terminal name as a label above each character, toggled via a setting."
29+
validations:
30+
required: true
31+
32+
- type: dropdown
33+
id: importance
34+
attributes:
35+
label: "How important is this to you?"
36+
options:
37+
- "Nice to have"
38+
- "Would improve my workflow"
39+
- "Critical — blocking my use case"
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: alternatives
45+
attributes:
46+
label: "Alternatives considered"
47+
description: "Have you considered other solutions or workarounds?"
48+
49+
- type: textarea
50+
id: context
51+
attributes:
52+
label: "Additional context"
53+
description: "Screenshots, mockups, links to related issues or discussions."

.github/workflows/pr-title.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: PR Title
2+
3+
on:
4+
pull_request_target:
5+
types: [opened, edited, synchronize]
6+
7+
permissions:
8+
pull-requests: read
9+
10+
jobs:
11+
check:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: amannn/action-semantic-pull-request@v5
15+
env:
16+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
17+
with:
18+
types: |
19+
feat
20+
fix
21+
refactor
22+
chore
23+
docs
24+
style
25+
perf
26+
test
27+
ci
28+
build
29+
requireScope: false
30+
subjectPattern: ^[a-z].+$
31+
subjectPatternError: "PR title subject must start with a lowercase letter: '{subject}'"

.github/workflows/update-badges.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Update Badge Stats
22

33
on:
44
schedule:
5-
- cron: '0 6 * * *'
5+
- cron: '0 6,14,22 * * *'
66
workflow_dispatch:
77

88
jobs:

CONTRIBUTING.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,17 +106,20 @@ These rules are set to `warn` — they won't block your PR but will flag violati
106106
```
107107
CI runs these same checks automatically on every PR.
108108
4. Open a pull request against `main` with:
109+
- A **conventional commit PR title** (e.g. `feat: add zoom controls`, `fix: character freezing on terminal close`, `refactor: extract pathfinding module`). CI enforces this format — see [Conventional Commits](https://www.conventionalcommits.org/).
109110
- A clear description of what changed and why
110111
- How you tested the changes (steps to reproduce / verify)
111112
- **Screenshots or GIFs for any UI changes**
112113

114+
> **Note:** PRs are merged using **squash and merge** — all commits in your PR are combined into a single commit on `main`. Your PR title becomes the commit message, which is why the conventional commit format matters.
115+
113116
## Reporting Bugs
114117

115118
[Open a bug report](https://github.com/pablodelucca/pixel-agents/issues/new?template=bug_report.yml) — the form will guide you through providing the details we need.
116119

117120
## Feature Requests
118121

119-
Have an idea? [Start a discussion](https://github.com/pablodelucca/pixel-agents/discussions/categories/ideas) in the Ideas category. We love hearing new ideas, and discussing them first helps us collaborate on the best approach together.
122+
Have an idea? [Open a feature request](https://github.com/pablodelucca/pixel-agents/issues/new?template=feature_request.yml) the form will guide you through describing the problem and your proposed solution. You can also browse and join ongoing conversations in [Discussions](https://github.com/pablodelucca/pixel-agents/discussions).
120123

121124
## Security Issues
122125

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,9 +139,7 @@ We're actively working on the core module and adapter architecture that makes th
139139

140140
## Community & Contributing
141141

142-
We use **[GitHub Discussions](https://github.com/pablodelucca/pixel-agents/discussions)** for questions, feature ideas, and conversations. **[Issues](https://github.com/pablodelucca/pixel-agents/issues)** are for bug reports only.
143-
144-
If something is broken, open an issue. For everything else, start a discussion.
142+
Use **[Issues](https://github.com/pablodelucca/pixel-agents/issues)** to report bugs or request features. Join **[Discussions](https://github.com/pablodelucca/pixel-agents/discussions)** for questions and conversations.
145143

146144
See [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute.
147145

0 commit comments

Comments
 (0)