docs: add CONTRIBUTING.md and GitHub issue/PR templates#9
Open
Krivoblotsky wants to merge 1 commit into
Open
Conversation
- CONTRIBUTING.md covers dev setup, running tests, commit conventions, and how to report bugs vs. security issues - .github/PULL_REQUEST_TEMPLATE.md prompts for summary, change type, and a testing checklist - .github/ISSUE_TEMPLATE/bug_report.md includes environment fields and an accessibility-permission checkbox (the most common omission) - .github/ISSUE_TEMPLATE/feature_request.md covers motivation and proposed API Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR adds contributor-facing documentation and GitHub templates to standardize how users open issues and how contributors submit pull requests.
Changes:
- Added
CONTRIBUTING.mdwith local setup guidance, workflow, and reporting pointers. - Added a PR template to encourage consistent summaries, change classification, and testing notes.
- Added issue templates for bug reports and feature requests to improve report quality and completeness.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
CONTRIBUTING.md |
Adds contributor workflow/setup/testing guidance and reporting/security pointers. |
.github/PULL_REQUEST_TEMPLATE.md |
Adds a structured PR template with testing and checklist prompts. |
.github/ISSUE_TEMPLATE/bug_report.md |
Adds a bug report template capturing environment, permissions, and repro details. |
.github/ISSUE_TEMPLATE/feature_request.md |
Adds a feature request template covering motivation, API proposal, and alternatives. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+26
to
+27
| # 3. Install with dev dependencies | ||
| pip install -e ".[dev]" |
| pytest | ||
| ``` | ||
|
|
||
| Since the library relies on live macOS Accessibility APIs, most tests require a running macOS session with the appropriate permissions. Tests that depend on a specific application being open are skipped automatically when that app is not available. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CONTRIBUTING.md— dev setup, test instructions, commit conventions, and where to report bugs vs. security issues.github/PULL_REQUEST_TEMPLATE.md— summary, change type checkboxes, testing checklist.github/ISSUE_TEMPLATE/bug_report.md— environment fields, accessibility-permission checkbox (most common omission in bug reports), repro steps.github/ISSUE_TEMPLATE/feature_request.md— motivation, proposed API, alternativesTest plan
🤖 Generated with Claude Code