Skip to content

Add GitHub issue and PR templates#44

Merged
kfirstri merged 1 commit intomainfrom
claude/issue-43-20260115-1540
Jan 18, 2026
Merged

Add GitHub issue and PR templates#44
kfirstri merged 1 commit intomainfrom
claude/issue-43-20260115-1540

Conversation

@kfirstri
Copy link
Contributor

Closes #43

Adds structured GitHub templates for:

  • Bug reports with environment details
  • Feature requests with problem/solution format
  • Pull requests with comprehensive checklist

These templates help contributors provide complete information and maintain consistency across issues and PRs.

Generated with Claude Code

- Add bug report template with structured fields
- Add feature request template for enhancement proposals
- Add pull request template with checklist
- Templates follow GitHub's YAML issue form format

Co-authored-by: Kfir Stri <kfirstri@users.noreply.github.com>
@github-actions
Copy link
Contributor

🚀 Package Preview Available!


Install this PR's preview build with npm:

npm i @base44-preview/cli@0.0.3-pr.44.1f8566c

Prefer not to change any import paths? Install using npm alias so your code still imports base44:

npm i "base44@npm:@base44-preview/cli@0.0.3-pr.44.1f8566c"

Or add it to your package.json dependencies:

{
  "dependencies": {
    "base44": "npm:@base44-preview/cli@0.0.3-pr.44.1f8566c"
  }
}

Preview published to npm registry — try new features instantly!

@claude
Copy link

claude bot commented Jan 15, 2026

PR Review: GitHub Issue and PR Templates

Thanks for adding these contribution templates! This is a valuable addition that will help standardize issue and PR submissions. Here's my comprehensive review:

✅ Strengths

Code Quality

  • Well-structured YAML: Bug report and feature request templates follow GitHub's YAML format correctly
  • Comprehensive fields: All templates capture the essential information needed for effective triage
  • Good defaults: Pre-filled environment section in bug reports is helpful
  • Clear placeholders: Examples guide users on what to provide

Best Practices Alignment

  • Project-specific details: Templates reference Base44 CLI commands and structure appropriately
  • AGENTS.md integration: PR checklist includes updating AGENTS.md for architectural changes (line 43 in PR template) - aligns well with project guidelines
  • Consistent branding: Templates use "Base44 CLI" consistently

🔍 Issues & Recommendations

1. Bug Report - CLI Version Detection (bug_report.yml:58)

Issue: Users need to manually find and enter the CLI version.
Recommendation: Add guidance for getting the version:

placeholder: |
  - OS: [e.g. macOS 14.0, Ubuntu 22.04, Windows 11]
  - Node.js version: [e.g. 20.19.0] (run: node --version)
  - CLI version: [e.g. 1.0.0] (run: base44 --version or npx base44 --version)

2. PR Template - Test Command Specificity (PULL_REQUEST_TEMPLATE.md:34)

Current: npm test
Consideration: According to AGENTS.md, the project also uses:

  • npm run typecheck - Type checking
  • npm run lint - Linting

Recommendation: Expand the testing checklist:

- [ ] All tests pass (`npm test`)
- [ ] Type checking passes (`npm run typecheck`)
- [ ] Linting passes (`npm run lint`)

3. PR Template - Build Step Missing

Issue: AGENTS.md line 261 mentions npm run build as a key development command, but the PR template doesn't verify the build succeeds.
Recommendation: Add to the testing section:

- [ ] Build succeeds (`npm run build`)

4. Feature Request - More CLI Context (feature_request.yml:40-43)

Enhancement: The placeholder shows base44 new-command which is good, but could be more illustrative.
Recommendation: Use a more concrete example that mirrors existing commands:

placeholder: |
  ```bash
  # Example: if adding a new 'deploy' command
  base44 deploy --environment production
  # Output: Deploying to production...

### 5. **Missing Config/Template Context in Bug Reports**
**Issue**: Base44 CLI uses `base44/config.jsonc` files. Bugs might be configuration-related.
**Recommendation**: Add a field in bug_report.yml after the environment section:
```yaml
- type: textarea
  id: config
  attributes:
    label: Configuration
    description: If relevant, share your base44/config.jsonc (remove sensitive data like app IDs)
    render: jsonc

🔒 Security Considerations

✅ Good practices:

  • Templates don't request sensitive information
  • Bug report asks for config files with explicit reminder to exclude sensitive data (per recommendation feat(login) - mock implementation #5)

⚠️ Minor concern:

  • Users might paste tokens or API keys in error logs
    Recommendation: Add a warning in the Error Logs section:
description: If applicable, paste any relevant error messages or logs (⚠️ remove any tokens, passwords, or API keys)

🎯 Test Coverage

Status: ✅ N/A - These are documentation/template files that don't require automated tests.

However, you should manually verify:

  • Create a test bug report to ensure YAML renders correctly
  • Create a test feature request to ensure all fields appear
  • Create a test PR to ensure the template auto-populates

⚡ Performance Considerations

Status: ✅ N/A - Static templates have no performance impact.

📋 Additional Suggestions

1. Add Issue Template Config

Create .github/ISSUE_TEMPLATE/config.yml to provide better navigation:

blank_issues_enabled: true
contact_links:
  - name: Documentation
    url: https://github.com/base44/cli/blob/main/README.md
    about: Check the documentation for usage guidelines
  - name: AGENTS.md - Development Guide
    url: https://github.com/base44/cli/blob/main/AGENTS.md
    about: Guidelines for contributors and AI agents

2. Consider Adding a Question Template

For general questions that aren't bugs or features, consider adding .github/ISSUE_TEMPLATE/question.yml.

3. Template Consistency

All three templates use good markdown/YAML formatting and are consistent in style. Well done!

🎬 Conclusion

Overall Assessment: ✅ Approve with minor suggestions

This is a solid PR that addresses issue #43 effectively. The templates are well-crafted, project-specific, and will significantly improve the quality of issue and PR submissions. The suggestions above are enhancements rather than blockers.

Estimated Impact:

  • Reduces back-and-forth on bug reports by capturing environment details upfront
  • Standardizes PR format and ensures contributors check AGENTS.md
  • Improves maintainer experience with consistent, complete submissions

Recommendation: Merge after considering the suggestions above (particularly #1, #2, and #7 which improve user guidance).

Great work @kfirstri! 🚀

@kfirstri kfirstri merged commit bd557e5 into main Jan 18, 2026
5 checks passed
@kfirstri kfirstri deleted the claude/issue-43-20260115-1540 branch January 18, 2026 11:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create contribution guide, including the template for Issues and PRs

1 participant