You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+18-30Lines changed: 18 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,26 +43,21 @@ Enhancement suggestions are welcome! Please:
43
43
44
44
### Pull Request Process
45
45
46
-
1.**Choose the appropriate PR template** for your change:
47
-
-**🚀 New Feature**: Use the `feature.md` template
48
-
-**🐛 Bug Fix**: Use the `bugfix.md` template
49
-
-**📖 Documentation**: Use the `documentation.md` template
50
-
-**🔧 Maintenance**: Use the `maintenance.md` template
51
-
-**Other**: Use the standard PR template
52
-
53
-
2.**Apply the correct label** after creating your PR:
54
-
-`enhancement` or `feature` - New functionality
55
-
-`bug` or `fix` - Bug fixes
56
-
-`documentation` or `docs` - Documentation updates
57
-
-`ignore-for-release` - Exclude from release notes
58
-
59
-
3. Follow the template provided.
60
-
4. Ensure your PR addresses only one concern (one feature, one bug fix).
61
-
5. Include tests for new functionality.
62
-
6. Update documentation if needed.
63
-
7. PRs must pass all checks before they can be merged.
64
-
65
-
**Note**: Labels are used to automatically categorize changes in release notes. The correct label helps maintainers and users understand what changed in each release.
46
+
1. Fill out the PR template — describe what changed, why, and link the issue.
47
+
2. Ensure your PR addresses only one concern (one feature, one bug fix).
48
+
3. Include tests for new functionality.
49
+
4. Update documentation if needed.
50
+
5. PRs must pass all CI checks before they can be merged.
51
+
52
+
### Issue Triage
53
+
54
+
Every new issue is automatically labeled `needs-triage`. Maintainers review incoming issues and:
55
+
56
+
1.**Accept** — remove `needs-triage`, add `accepted`, and assign a milestone.
57
+
2.**Prioritize** — optionally add `priority/high` or `priority/low`.
58
+
3.**Close** — if it's a duplicate (`duplicate`) or out of scope, close with a comment explaining why.
59
+
60
+
Labels used for triage: `needs-triage`, `accepted`, `needs-design`, `priority/high`, `priority/low`.
66
61
67
62
## Development Environment
68
63
@@ -73,22 +68,15 @@ This project uses uv to manage Python environments and dependencies:
73
68
git clone <this-repo-url>
74
69
cd apm
75
70
76
-
# Create a virtual environment and install dependencies
77
-
uv venv
78
-
source venv/bin/activate # On Windows, use: venv\Scripts\activate
79
-
uv pip install -e ".[dev]"
71
+
# Install all dependencies (creates .venv automatically)
72
+
uv sync --extra dev
80
73
```
81
74
82
75
## Testing
83
76
84
-
We use pytest for testing. The project uses `uv` to manage virtual environments and dependencies — the recommended way to run tests is:
77
+
We use pytest for testing. After completing the setup above, run the test suite with:
85
78
86
79
```bash
87
-
uv run pytest
88
-
# install dev dependencies (creates .venv managed by uv)
0 commit comments