Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
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
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
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.
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
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/`)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
- [ ] Linting passes (`ruff check src/ tests/`)
- [ ] Linting passes (ruff check src/ tests/)
- [ ] Formatting passes (ruff format --check src/ tests/)
References
  1. The CONTRIBUTING.md file (line 52) specifies the linting and formatting requirements that should be reflected in the PR checklist. (link)
  2. Project descriptions and templates should maintain a professional tone by avoiding informal abbreviations like 'etc.' and ensuring proper punctuation.

Copy link
Copy Markdown
Owner Author

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 --check and mypy to the PR template checklist.

- [ ] 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.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,14 @@ pre-commit install
5. Ensure formatting: `ruff format --check src/ tests/`
6. Submit a PR with a description of changes

### Pull Request Quality Expectations

- **Reference an issue**: PRs should link to an existing issue or clearly describe the problem being solved. If no issue exists, open one first for discussion.
- **AI-assisted contributions**: Welcome, but the submitter must review, understand, and test the code before submitting. PRs that appear to be unreviewed AI output will be closed.
- **No duplicates**: Check existing open PRs before submitting. Duplicate PRs for the same issue will be closed in favor of the first or best submission.
- **Accurate severity**: Claims of "critical" bugs must include evidence (stack trace, reproduction steps, affected users). Routine edge cases are not critical.
- **Tested locally**: All PRs must include evidence of local testing. The PR template includes a checklist for this.

---

## Documentation Rules for AI Agents
Expand Down
Loading