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
15 changes: 15 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# These are supported funding model platforms

github: [DylanDevelops] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
polar: # Replace with a single Polar username
buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
thanks_dev: # Replace with a single thanks.dev username
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: 🐛 Bug Report
description: File a bug report
labels: ["status: awaiting triage", "type: bug"]
body:
- type: markdown
attributes:
value: |
Thanks for filing a bug report! This issue tracker is for [tmpo](https://github.com/DylanDevelops/tmpo). Please search the issue tracker to see if there is an existing issue for the problem you are experiencing.
- type: textarea
id: the-problem
attributes:
label: The problem
description:
Describe the issue you are experiencing with tmpo. Provide a
clear and concise description of what you were trying to do and what
happened, along with any error messages you encountered.
validations:
required: true
- type: input
id: version
attributes:
label: Release version
description:
Run `tmpo version`
validations:
required: true
- type: input
id: operating-system
attributes:
label: Operating system
description:
'Enter the specific operating system version you are running (example:
Windows 11)'
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce the behavior
description: Provide steps to reproduce the problem you are experiencing.
placeholder: |
1. Go to '...'
2. Do '....'
3. Run tmpo '....'
4. See error
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: Add screenshots to help explain your problem, if applicable.
- type: textarea
id: additional-context
attributes:
label: Additional context
description:
Add any other context about the problem you are experiencing here.
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: true
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: ⭐ Feature Request
description: Submit a feature request
labels: ["status: awaiting triage", "type: feature request"]
body:
- type: markdown
attributes:
value: |
Thanks for submitting a feature request! This issue tracker is for [tmpo](https://github.com/DylanDevelops/tmpo). Please search the issue tracker to see if there is an existing issue for the feature you are requesting.
- type: textarea
id: the-feature-request
attributes:
label: The feature request
description:
Write a clear and concise description of what the feature or problem is.
validations:
required: true
- type: textarea
id: proposed-solution
attributes:
label: Proposed solution
description: Share how this will benefit tmpo and its users.
validations:
required: true
- type: textarea
id: additional-context
attributes:
label: Additional context
description:
Please include any other context, like screenshots or mockups, if
applicable.
83 changes: 83 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Contributor Covenant 3.0 Code of Conduct

## Our Pledge

We pledge to make our community welcoming, safe, and equitable for all.

We are committed to fostering an environment that respects and promotes the dignity, rights, and contributions of all individuals, regardless of characteristics including race, ethnicity, caste, color, age, physical characteristics, neurodiversity, disability, sex or gender, gender identity or expression, sexual orientation, language, philosophy or religion, national or social origin, socio-economic position, level of education, or other status. The same privileges of participation are extended to everyone who participates in good faith and in accordance with this Covenant.

## Encouraged Behaviors

While acknowledging differences in social norms, we all strive to meet our community's expectations for positive behavior. We also understand that our words and actions may be interpreted differently than we intend based on culture, background, or native language.

With these considerations in mind, we agree to behave mindfully toward each other and act in ways that center our shared values, including:

1. Respecting the **purpose of our community**, our activities, and our ways of gathering.
2. Engaging **kindly and honestly** with others.
3. Respecting **different viewpoints** and experiences.
4. **Taking responsibility** for our actions and contributions.
5. Gracefully giving and accepting **constructive feedback**.
6. Committing to **repairing harm** when it occurs.
7. Behaving in other ways that promote and sustain the **well-being of our community**.

## Restricted Behaviors

We agree to restrict the following behaviors in our community. Instances, threats, and promotion of these behaviors are violations of this Code of Conduct.

1. **Harassment.** Violating explicitly expressed boundaries or engaging in unnecessary personal attention after any clear request to stop.
2. **Character attacks.** Making insulting, demeaning, or pejorative comments directed at a community member or group of people.
3. **Stereotyping or discrimination.** Characterizing anyone’s personality or behavior on the basis of immutable identities or traits.
4. **Sexualization.** Behaving in a way that would generally be considered inappropriately intimate in the context or purpose of the community.
5. **Violating confidentiality**. Sharing or acting on someone's personal or private information without their permission.
6. **Endangerment.** Causing, encouraging, or threatening violence or other harm toward any person or group.
7. Behaving in other ways that **threaten the well-being** of our community.

### Other Restrictions

1. **Misleading identity.** Impersonating someone else for any reason, or pretending to be someone else to evade enforcement actions.
2. **Failing to credit sources.** Not properly crediting the sources of content you contribute.
3. **Promotional materials**. Sharing marketing or other commercial content in a way that is outside the norms of the community.
4. **Irresponsible communication.** Failing to responsibly present content which includes, links or describes any other restricted behaviors.

## Reporting an Issue

Tensions can occur between community members even when they are trying their best to collaborate. Not every conflict represents a code of conduct violation, and this Code of Conduct reinforces encouraged behaviors and norms that can help avoid conflicts and minimize harm.

When an incident does occur, it is important to report it promptly. To report a possible violation, **please contact a project maintainer. If the issue involves a maintainer, please contact the project owner via email.**

Community Moderators take reports of violations seriously and will make every effort to respond in a timely manner. They will investigate all reports of code of conduct violations, reviewing messages, logs, and recordings, or interviewing witnesses and other participants. Community Moderators will keep investigation and enforcement actions as transparent as possible while prioritizing safety and confidentiality. In order to honor these values, enforcement actions are carried out in private with the involved parties, but communicating to the whole community may be part of a mutually agreed upon resolution.

## Addressing and Repairing Harm

If an investigation by the Community Moderators finds that this Code of Conduct has been violated, the following enforcement ladder may be used to determine how best to repair harm, based on the incident's impact on the individuals involved and the community as a whole. Depending on the severity of a violation, lower rungs on the ladder may be skipped.

1) Warning
1) Event: A violation involving a single incident or series of incidents.
2) Consequence: A private, written warning from the Community Moderators.
3) Repair: Examples of repair include a private written apology, acknowledgement of responsibility, and seeking clarification on expectations.
2) Temporarily Limited Activities
1) Event: A repeated incidence of a violation that previously resulted in a warning, or the first incidence of a more serious violation.
2) Consequence: A private, written warning with a time-limited cooldown period designed to underscore the seriousness of the situation and give the community members involved time to process the incident. The cooldown period may be limited to particular communication channels or interactions with particular community members.
3) Repair: Examples of repair may include making an apology, using the cooldown period to reflect on actions and impact, and being thoughtful about re-entering community spaces after the period is over.
3) Temporary Suspension
1) Event: A pattern of repeated violation which the Community Moderators have tried to address with warnings, or a single serious violation.
2) Consequence: A private written warning with conditions for return from suspension. In general, temporary suspensions give the person being suspended time to reflect upon their behavior and possible corrective actions.
3) Repair: Examples of repair include respecting the spirit of the suspension, meeting the specified conditions for return, and being thoughtful about how to reintegrate with the community when the suspension is lifted.
4) Permanent Ban
1) Event: A pattern of repeated code of conduct violations that other steps on the ladder have failed to resolve, or a violation so serious that the Community Moderators determine there is no way to keep the community safe with this person as a member.
2) Consequence: Access to all community spaces, tools, and communication channels is removed. In general, permanent bans should be rarely used, should have strong reasoning behind them, and should only be resorted to if working through other remedies has failed to change the behavior.
3) Repair: There is no possible repair in cases of this severity.

This enforcement ladder is intended as a guideline. It does not limit the ability of Community Managers to use their discretion and judgment, in keeping with the best interests of our community.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public or other spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 3.0, permanently available at [https://www.contributor-covenant.org/version/3/0/](https://www.contributor-covenant.org/version/3/0/).

Contributor Covenant is stewarded by the Organization for Ethical Source and licensed under CC BY-SA 4.0. To view a copy of this license, visit [https://creativecommons.org/licenses/by-sa/4.0/](https://creativecommons.org/licenses/by-sa/4.0/)

For answers to common questions about Contributor Covenant, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are provided at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations). Additional enforcement and community guideline resources can be found at [https://www.contributor-covenant.org/resources](https://www.contributor-covenant.org/resources). The enforcement ladder was inspired by the work of [Mozilla’s code of conduct team](https://github.com/mozilla/inclusion).
195 changes: 195 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,195 @@
# Contributing to tmpo

Thank you for your interest in contributing to tmpo! This document provides guidelines and instructions for contributing to the project.

## Getting Started

### Prerequisites

- Go 1.21 or higher
- Git

### Setting Up Your Development Environment

1. [Fork](https://github.com/DylanDevelops/tmpo/fork) the repository
2. Clone your fork:

```bash
git clone https://github.com/YOUR_USERNAME/tmpo.git
cd tmpo
```

3. Add the upstream repository:

```bash
git remote add upstream https://github.com/DylanDevelops/tmpo.git
```

## Development Workflow

### Building

```bash
# Build for local development
go build -o tmpo .

# Run the binary
./tmpo --help
```

### Testing

```bash
# Run all tests
go test -v ./...

# Run tests with coverage
go test -v -cover ./...
```

### Building Releases

```bash
# Build with goreleaser (for testing release builds)
goreleaser build --snapshot --clean
```

## Project Structure

```
tmpo/
├── cmd/ # CLI commands (Using Cobra)
│ ├── command1.go
│ ├── command2.go
│ ├── command3.go
│ ├── ...
├── internal/
│ ├── config/ # Configuration management (.tmporc files)
│ ├── storage/ # SQLite database layer
│ ├── project/ # Project detection logic
│ └── export/ # Export functionality
├── docs/ # User documentation
│ ├── usage.md
│ └── configuration.md
├── main.go
└── README.md
```

### Key Directories

- **`cmd/`**: Contains all CLI command implementations using Cobra
- **`internal/config/`**: Handles `.tmporc` file parsing and configuration
- **`internal/storage/`**: SQLite database operations and models
- **`internal/project/`**: Project name detection logic (git/directory/config)
- **`internal/export/`**: Export functionality used by commands
- **`docs/`**: User-facing documentation and guides

### Data Storage

All user data is stored locally in:

```
~/.tmpo/
└── tmpo.db # SQLite database
```

The database schema includes:

- Time entries (start/end times, project, description)
- Project metadata (derived from entries)
- Automatic indexing for fast queries

### How Project Detection Works

When a user runs `tmpo start`, the project name is detected in this priority order:

1. **`.tmporc` file** - Searches current directory and all parent directories
2. **Git repository** - Uses `git rev-parse --show-toplevel` to find repo root
3. **Directory name** - Falls back to current directory name

This logic lives in `internal/project/detector.go`.

## Making Changes

### Branching

Create a feature branch from `main`:

```bash
git checkout -b feature/your-feature-name
```

Use descriptive branch names such as:

- `feature/add-pause-command`
- `fix/status-display-bug`
- `docs/update-readme`

### Code Style

- Follow standard Go conventions and use `gofmt`
- Write clear, descriptive commit messages
- Add comments for complex logic
- Keep functions focused and modular

### Commit Messages

Use clear, imperative commit messages:

```
Add pause/resume functionality

- Implement pause command to temporarily stop tracking
- Add resume command to continue paused sessions
- Update status command to show paused state
```

## Submitting Changes

1. Ensure all tests pass: `go test -v ./...`
2. Commit your changes with descriptive messages
3. Push to your fork:

```bash
git push origin feature/your-feature-name
```

4. Open a Pull Request against the `main` branch
5. Describe your changes and link any related issues

### Pull Request Guidelines

- Provide a clear description of the changes
- Reference any related issues (e.g., "Fixes #123")
- Ensure tests pass and code builds successfully
- Be responsive to feedback and questions

Reviews can take a few iterations, especially for large contributions. Don't be disheartened if you feel it takes time - we just want to ensure each contribution is high-quality and that any outstanding questions are resolved, captured or documented for posterity.

## Reporting Issues

When reporting bugs or requesting features, please:

1. Check existing issues first to avoid duplicates
2. Use the issue templates provided
3. Include relevant details:
- tmpo version (`tmpo --version`)
- Operating system
- Steps to reproduce (for bugs)
- Expected vs actual behavior

## Questions?

Feel free to [open an issue](https://github.com/DylanDevelops/tmpo/issues/new/choose) for questions or discussions about:

- Feature ideas
- Implementation approaches
- Project architecture

## Code of Conduct

Be respectful and constructive in all interactions. We're all here to make tmpo better!

---

Thank you for contributing to tmpo!
Loading
Loading