Skip to content
Closed
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
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: Bug Report
about: Report a bug or unexpected behavior
title: '[BUG] '
labels: bug
assignees: ''
---

## Bug Description

A clear and concise description of what the bug is.

## Steps to Reproduce

1. Run command '...'
2. With options '...'
3. See error

## Expected Behavior

What you expected to happen.

## Actual Behavior

What actually happened.

## Error Message

```
Paste any error messages here
```

## Environment

- **Downfolio version**: [run `downfolio version`]
- **OS**: [e.g., macOS 13.0, Ubuntu 22.04, Windows 11]
- **Node.js version**: [run `node --version`]
- **Package manager**: [pnpm/npm/yarn and version]
- **Pandoc version**: [run `pandoc --version` if applicable]

## Additional Context

Add any other context about the problem here (screenshots, logs, etc.)

## Possible Solution

(Optional) If you have ideas on how to fix this.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Feature Request
about: Suggest a new feature or enhancement
title: '[FEATURE] '
labels: enhancement
assignees: ''
---

## Feature Description

A clear and concise description of the feature you'd like to see.

## Motivation

Why is this feature important? What problem does it solve?

## Proposed Solution

How would you like this feature to work?

Example:
```bash
downfolio your-command --your-flag
```

## Alternatives Considered

Have you considered any alternative solutions or features?

## Use Case

Describe your specific use case for this feature.

## Additional Context

Add any other context, screenshots, or examples about the feature request here.

## Examples from Other Tools

(Optional) If other tools have similar features, provide examples.
58 changes: 58 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Pull Request

## Description

Brief description of what this PR does.

## Type of Change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Code refactoring
- [ ] Performance improvement
- [ ] Test updates

## Related Issues

Fixes #(issue number)

## Changes Made

- List key changes
- Use bullet points
- Be specific

## Testing

### How Has This Been Tested?

- [ ] Unit tests
- [ ] Integration tests
- [ ] Manual testing

### Test Configuration

- Node.js version:
- Operating System:
- Any special setup required:

## Checklist

- [ ] My code follows the project's style guidelines
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published

## Screenshots (if applicable)

Add screenshots to help explain your changes.

## Additional Notes

Any additional information that reviewers should know.
20 changes: 19 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
# Source files (we ship compiled dist/)
src/
tsconfig.json
*.md
vitest.config.ts

# Test files
tests/

# Development files
.gitignore
.npmignore
.DS_Store
.env
.env.example

# GitHub files (keep these for npm package visibility)
# .github/ is included by default

# Keep important documentation
# README.md - included by default
# CONTRIBUTING.md - included
# TROUBLESHOOTING.md - included
# CHANGELOG.md - included
# examples/ - included
Loading