Skip to content

Commit 2bc8a1b

Browse files
committed
docs: Fix npm package name, repository links, and documentation
1 parent b049204 commit 2bc8a1b

File tree

10 files changed

+608
-60
lines changed

10 files changed

+608
-60
lines changed
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve TaskTracker
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## **Bug Description**
11+
A clear and concise description of what the bug is.
12+
13+
## **To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Run command `tt ...`
16+
2. With arguments `...`
17+
3. See error
18+
19+
## **Expected Behavior**
20+
A clear description of what you expected to happen.
21+
22+
## **Actual Behavior**
23+
What actually happened instead.
24+
25+
## **Error Output**
26+
```
27+
Paste any error messages here
28+
```
29+
30+
## **Environment**
31+
- OS: [e.g. macOS 13.0, Ubuntu 20.04, Windows 11]
32+
- Node.js version: [e.g. 18.17.0]
33+
- TaskTracker version: [e.g. 3.0.0]
34+
- Shell: [e.g. bash, zsh, fish]
35+
36+
## **Journal Context** (if relevant)
37+
- Number of journal entries: [e.g. ~50]
38+
- Git integration enabled: [yes/no]
39+
- Project type: [e.g. Node.js, Python, etc.]
40+
41+
## **Additional Context**
42+
Add any other context about the problem here.
43+
44+
## **Possible Solution** (optional)
45+
If you have ideas on how to fix this, please share.
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for TaskTracker
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## **Is your feature request related to a problem?**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
## **Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
## **Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
## **Use Case**
20+
Describe how this feature would be used in your workflow:
21+
- What commands would you run?
22+
- How often would you use this?
23+
- What problem does it solve?
24+
25+
## **Example Usage**
26+
If possible, show what the command/feature would look like:
27+
```bash
28+
tt your-new-feature --example
29+
```
30+
31+
## **Would this be breaking?**
32+
- [ ] This would break existing functionality
33+
- [ ] This is purely additive
34+
- [ ] Not sure
35+
36+
## **Additional context**
37+
Add any other context, mockups, or screenshots about the feature request here.
38+
39+
## **Implementation Ideas** (optional)
40+
If you have ideas on how this could be implemented, please share.

CODE_OF_CONDUCT.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all community spaces, and also applies when
49+
an individual is officially representing the community in public spaces.
50+
51+
## Enforcement
52+
53+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
54+
reported to the community leaders responsible for enforcement at
55+
[INSERT CONTACT METHOD]. All complaints will be reviewed and investigated
56+
promptly and fairly.
57+
58+
## Attribution
59+
60+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
61+
version 2.0, available at
62+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
63+
64+
[homepage]: https://www.contributor-covenant.org

CONTRIBUTING.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,56 @@
11
# Contributing to TaskTracker
22

3-
Thank you for your interest in contributing to TaskTracker! This document provides guidelines and information for contributors.
3+
We love your input! We want to make contributing to TaskTracker as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
## We Develop with GitHub
12+
13+
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
14+
15+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html)
16+
17+
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
18+
19+
1. Fork the repo and create your branch from `main`.
20+
2. If you've added code that should be tested, add tests.
21+
3. If you've changed APIs, update the documentation.
22+
4. Ensure the test suite passes.
23+
5. Make sure your code lints.
24+
6. Issue that pull request!
25+
26+
## Any contributions you make will be under the MIT Software License
27+
28+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
29+
30+
## Report bugs using GitHub's [issue tracker](https://github.com/DVC2/task_tracker/issues)
31+
32+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/DVC2/task_tracker/issues/new); it's that easy!
33+
34+
## Write bug reports with detail, background, and sample code
35+
36+
**Great Bug Reports** tend to have:
37+
38+
- A quick summary and/or background
39+
- Steps to reproduce
40+
- Be specific!
41+
- Give sample code if you can.
42+
- What you expected would happen
43+
- What actually happens
44+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
45+
46+
## Use a Consistent Coding Style
47+
48+
* Use 2 spaces for indentation rather than tabs
49+
* You can try running `npm run lint` for style unification
50+
51+
## License
52+
53+
By contributing, you agree that your contributions will be licensed under its MIT License.
454

555
## 🚀 Quick Start
656

README.md

Lines changed: 59 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# TaskTracker: Developer Context Journal 📝
22

3-
[![npm version](https://badge.fury.io/js/@dvc2%2Ftasktracker-cli.svg)](https://badge.fury.io/js/@dvc2%2Ftasktracker-cli)
3+
[![npm version](https://badge.fury.io/js/@dvc2%2Ftasktracker-cli.svg)](https://www.npmjs.com/package/@dvc2/tasktracker-cli)
4+
[![npm downloads](https://img.shields.io/npm/dm/@dvc2/tasktracker-cli.svg)](https://www.npmjs.com/package/@dvc2/tasktracker-cli)
45
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
56
[![Node.js CI](https://github.com/DVC2/task_tracker/actions/workflows/test.yml/badge.svg)](https://github.com/DVC2/task_tracker/actions/workflows/test.yml)
67

@@ -41,15 +42,37 @@ tt c # Quick context
4142
tt cf # Full context with history
4243
```
4344

45+
## 🚀 **Git Integration (NEW!)**
46+
47+
Seamlessly capture your development history:
48+
```bash
49+
# Install git hooks for auto-journaling
50+
tt git-install-hook
51+
52+
# Now every commit automatically creates a journal entry!
53+
git commit -m "feat: Add user authentication"
54+
# → Automatically journaled with tags: git, feat, main
55+
56+
# Import recent commits
57+
tt git-sync 10
58+
59+
# Toggle auto-prompting
60+
tt git-auto off # Disable context prompting
61+
```
62+
4463
## 📖 **Core Features**
4564

4665
### Development Journal
4766
Track your progress, decisions, and blockers:
4867
```bash
49-
tt j "Completed user authentication flow"
50-
tt j --type decision "Switching from MongoDB to PostgreSQL"
51-
tt j --type blocker "CORS issues with frontend"
52-
tt j --tags api,auth "Added rate limiting to login endpoint"
68+
# Quick aliases for common entries
69+
tt done "Completed user authentication flow"
70+
tt decided "Switching from MongoDB to PostgreSQL"
71+
tt blocked "CORS issues with frontend"
72+
tt til "Redis connection pooling improves performance"
73+
74+
# Or use the full command
75+
tt j "Added rate limiting to login endpoint" --tags api,auth
5376
```
5477

5578
### PRD Management
@@ -89,19 +112,19 @@ tt c
89112
### During Development
90113
```bash
91114
# Track progress
92-
tt j "Added user profile endpoints"
115+
tt done "Added user profile endpoints"
93116

94117
# Document decisions
95-
tt j --type decision "Using Redis for session storage - built-in expiration"
118+
tt decided "Using Redis for session storage - built-in expiration"
96119

97120
# Note blockers
98-
tt j --type blocker "WebSocket connection drops after 30 seconds"
121+
tt blocked "WebSocket connection drops after 30 seconds"
99122
```
100123

101124
### Debugging with AI
102125
```bash
103126
# Document the issue
104-
tt j --type blocker "Users can't login - 401 errors"
127+
tt blocked "Users can't login - 401 errors"
105128

106129
# Add context
107130
tt j "Checked: JWT secret is correct, token format is valid"
@@ -119,6 +142,18 @@ tt cf 1 # Just today's context
119142
- `tt journal-search "query"` - Search entries
120143
- `tt journal-export [format]` - Export journal
121144

145+
### Productivity Aliases
146+
- `tt done "text"` - Quick progress entry
147+
- `tt decided "text"` - Quick decision entry
148+
- `tt blocked "text"` - Quick blocker entry
149+
- `tt til "text"` - Quick learning entry
150+
151+
### Git Integration
152+
- `tt git-install-hook` - Install auto-journaling hook
153+
- `tt git-sync [count]` - Import recent commits
154+
- `tt git-auto [on|off]` - Toggle auto-prompting
155+
- `tt git-status` - Show integration status
156+
122157
### Context Commands
123158
- `tt context-quick` (alias: `tt c`) - Quick context
124159
- `tt context-full [days]` (alias: `tt cf`) - Full context
@@ -157,7 +192,7 @@ tt journal-export json --output backup.json
157192

158193
## 🎨 **What Makes TaskTracker Different**
159194

160-
1. **Not Another Task Manager** - It's a context journal, not a todo list
195+
1. **Git Integration** - Automatically captures your development history
161196
2. **AI-First Design** - Built specifically for AI-assisted development
162197
3. **Zero Friction** - Simple commands that fit your workflow
163198
4. **Local & Private** - Your data stays in your project
@@ -185,7 +220,8 @@ See [AI Integration Guide](docs/AI_INTEGRATION_GUIDE.md) for detailed patterns a
185220
- ✅ All journal functionality (add, show, search, export)
186221
- ✅ PRD parsing and management
187222
- ✅ AI context generation (quick & full)
188-
- ✅ Proper CLI argument parsing
223+
- ✅ Git integration with auto-journaling
224+
- ✅ Productivity aliases for quick entries
189225
- ✅ Clean, maintainable codebase
190226
- ✅ Comprehensive test coverage
191227

@@ -205,45 +241,25 @@ TaskTracker stores all data locally in the `.tasktracker/` directory. This direc
205241
- Never commit real journal data to public repositories
206242
- Use the sanitized examples in `examples/` for demos or documentation
207243

208-
If you need to share examples, use the sanitized data in the `examples/` directory instead of your real journal entries.
244+
## 📚 **Examples & Documentation**
209245

210-
## 🛠️ **Development**
211-
212-
```bash
213-
# Clone and install
214-
git clone https://github.com/tasktracker-cli/tasktracker.git
215-
cd tasktracker
216-
npm install
217-
218-
# Run tests
219-
npm test
220-
221-
# Lint code
222-
npm run lint:check
223-
npm run lint:fix
224-
```
225-
226-
See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed development guidelines.
246+
Check out the [examples directory](examples/) for:
247+
- Sample journal entries
248+
- Example configurations
249+
- Usage patterns
250+
- Best practices
227251

228252
## 🤝 **Contributing**
229253

230-
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
231-
232-
### Quick Contribution Steps
233-
1. Fork the repository
234-
2. Create a feature branch
235-
3. Make your changes with tests
236-
4. Submit a pull request
237-
238-
## 🐛 **Issues & Support**
239-
240-
- **Bug Reports**: [GitHub Issues](https://github.com/tasktracker-cli/tasktracker/issues)
241-
- **Feature Requests**: [GitHub Discussions](https://github.com/tasktracker-cli/tasktracker/discussions)
242-
- **Documentation**: [docs/](docs/) directory
254+
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for:
255+
- Development setup
256+
- Code style guide
257+
- Pull request process
258+
- Testing requirements
243259

244260
## 📄 **License**
245261

246-
MIT License - see [LICENSE](LICENSE) file for details.
262+
TaskTracker is [MIT licensed](LICENSE).
247263

248264
## 🙏 **Acknowledgments**
249265

0 commit comments

Comments
 (0)