Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
146 lines (110 loc) · 4.34 KB

CONTRIBUTING.md

File metadata and controls

146 lines (110 loc) · 4.34 KB

Contributing to Simple Coding Time Tracker

We're excited that you're interested in contributing to VSCode Time Tracker! This document will guide you through the process of setting up the project, making changes, and submitting your contributions.

Project Structure

The project is organized as follows:

vscode-time-tracker/
├── .vscode/               # VSCode-specific settings
├── src/                   # Source code
│   ├── extension.ts       # Main extension file (includes test data commands)
│   ├── statusBar.ts       # Status bar functionality
│   ├── summaryView.ts     # Summary view implementation
│   ├── timeTracker.ts     # Time tracking logic
│   ├── database.ts        # Database operations
│   ├── healthNotifications.ts # Health notification system
│   ├── logger.ts          # Logging utilities
│   └── utils.ts           # Utility functions
├── .gitignore             # Git ignore file
├── package.json           # Project metadata, dependencies, and test commands
├── README.md              # Project readme
├── CONTRIBUTING.md        # Contributing guidelines
├── TECHNICAL.md           # Technical documentation and testing guide
└── LICENSE                # License information

Setting Up the Development Environment

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/vsc-ext-coding-time-tracker.git
  3. Navigate to the project directory: 
    cd vsc-ext-coding-time-tracker
  4. Install dependencies: 
    npm install

Compiling the Extension

To compile the extension, run:

npm run compile

This will transpile the TypeScript files to JavaScript.

Testing the Extension

Development Mode Testing

For testing during development:

  1. Open the project in VS Code
  2. Press F5 to launch Extension Development Host
  3. Test your changes in the new VS Code window

Package Testing

For testing packaged extensions:

  1. Enable test commands:

    • Open Settings (Ctrl+,)
    • Search "enableDevCommands"
    • Enable "Simple Coding Time Tracker › Enable Dev Commands"

  2. Generate test data:

    • Press Ctrl+Shift+P
    • Run SCTT: Generate Test Data (Dev)
    • This creates 90 days of realistic test data

  3. Test all features:

    • Summary view and charts
    • Search and filtering
    • Status bar functionality
    • Theme compatibility

  4. Clean up:

    • Run SCTT: Delete Test Data (Dev) to remove test data
    • Disable dev commands when done

Testing Checklist

Before submitting a pull request, verify:

  • ✅ Time tracking starts/stops correctly
  • ✅ Status bar updates in real-time
  • ✅ Charts render properly in light/dark themes
  • ✅ Search and filtering work correctly
  • ✅ Data persists across VS Code restarts
  • ✅ Health notifications function (if enabled)
  • ✅ Extension works with packaged installation
  • ✅ No console errors in Developer Tools

Creating a VSCode Package

To package the extension for distribution:

  1. Install vsce globally if you haven't already: 
    npm install -g vsce
  2. Package the extension: 
    vsce package

This will create a .vsix file that can be installed in VSCode.

Making Changes

  1. Create a new branch for your feature or bug fix: 
    git checkout -b feature/your-feature-name
  2. Make your changes and commit them with a clear, descriptive commit message.
  3. Push your changes to your fork: 
    git push origin feature/your-feature-name

Creating a Pull Request

  1. Go to the original repository on GitHub.
  2. Click on "Pull requests" and then "New pull request".
  3. Select your fork and the branch containing your changes.
  4. Fill out the pull request template with a clear description of your changes.
  5. Submit the pull request.

Code Style and Guidelines

  • Follow the existing code style in the project.
  • Use meaningful variable and function names.
  • Comment your code where necessary, especially for complex logic.
  • Ensure your code passes all existing tests and add new tests for new functionality.

Questions or Need Help?

If you have any questions or need assistance, please open an issue on the GitHub repository, and we'll be happy to help!

Thank you for contributing to Simple Coding Time Tracker!