-
Notifications
You must be signed in to change notification settings - Fork 1.4k
docs: add contribution templates and triage bot-generated PRs #251
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+100
−0
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
aeadb3a
docs: add contribution templates and PR quality guidelines
81d63a4
fix: address review feedback on templates
74ec98e
fix: add language identifier to fenced code block in bug report template
bec108b
fix: add bash language identifier to debug output code fence
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| name: Bug Report | ||
| about: Report a bug in notebooklm-py | ||
| title: "" | ||
| labels: bug | ||
| assignees: "" | ||
| --- | ||
|
|
||
| ## Description | ||
|
|
||
| A clear description of the bug. | ||
|
|
||
| ## Steps to Reproduce | ||
|
|
||
| 1. ... | ||
| 2. ... | ||
| 3. ... | ||
|
|
||
| ## Expected Behavior | ||
|
|
||
| What you expected to happen. | ||
|
|
||
| ## Actual Behavior | ||
|
|
||
| What actually happened. Include the full error message or traceback if applicable. | ||
|
|
||
| ```text | ||
| Paste error output here | ||
| ``` | ||
|
|
||
| ## Environment | ||
|
|
||
| - OS: (e.g., macOS 15, Ubuntu 24.04, Windows 11) | ||
| - Python version: (e.g., 3.12) | ||
| - notebooklm-py version: (run `notebooklm --version`) | ||
| - Install method: (pip, uv, pipx) | ||
|
|
||
| ## Debug Output | ||
|
|
||
| If applicable, run the failing command with `-vv` for verbose logging and paste the relevant output: | ||
|
|
||
| ```bash | ||
| notebooklm -vv <your-command-here> | ||
| ``` | ||
|
|
||
| ## Checklist | ||
|
|
||
| - [ ] I verified this bug exists on the latest version of notebooklm-py | ||
| - [ ] I searched existing issues and this is not a duplicate |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| blank_issues_enabled: false |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| name: Feature Request | ||
| about: Suggest a new feature or enhancement | ||
| title: "" | ||
| labels: enhancement | ||
| assignees: "" | ||
| --- | ||
|
|
||
| ## Use Case | ||
|
|
||
| Describe the problem or workflow this feature would address. | ||
|
|
||
| ## Proposed Solution | ||
|
|
||
| How you'd like this to work (CLI usage, API example, etc.). | ||
|
|
||
| ## Alternatives Considered | ||
|
|
||
| Any alternative approaches you've thought of. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| ## Summary | ||
|
|
||
| Brief description of the changes. | ||
|
|
||
| ## Related Issue | ||
|
|
||
| Closes #<issue_number> | ||
|
|
||
| ## Changes | ||
|
|
||
| - ... | ||
|
|
||
| ## Test Plan | ||
|
|
||
| - [ ] I tested these changes locally | ||
| - [ ] Tests pass (`pytest`) | ||
| - [ ] Linting passes (`ruff check src/ tests/`) | ||
| - [ ] Formatting passes (`ruff format --check src/ tests/`) | ||
| - [ ] Type checking passes (`mypy src/notebooklm --ignore-missing-imports`) | ||
|
|
||
| ## Notes | ||
|
|
||
| Any additional context, trade-offs, or design decisions. | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR template should include a check for code formatting to align with the requirements specified in
CONTRIBUTING.md(line 52). Additionally, using backticks for commands improves readability and consistency with the rest of the documentation.References
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Already addressed in commit 81d63a4: added
ruff format --checkandmypyto the PR template checklist.