Skip to content

Latest commit

 

History

History
90 lines (68 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

90 lines (68 loc) · 2.49 KB

Contributing to tdeo

Thank you for your interest in contributing to tdeo!

License Agreement

Important: By contributing to this project, you agree that your contributions will be licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

This means:

  • Your code will be open source forever
  • Anyone using a modified version over a network must provide source code
  • Derivative works must also be AGPL-3.0 licensed
  • You retain copyright of your contributions, but grant license under AGPL-3.0

If you do not agree to these terms, please do not submit contributions.

How to Contribute

Reporting Bugs

  1. Check existing issues to avoid duplicates
  2. Create a new issue with:
    • Clear title
    • Steps to reproduce
    • Expected vs actual behavior
    • VS Code version and OS

Submitting Code

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/my-feature)
  3. Make your changes
  4. Add copyright notice to new files (see below)
  5. Test your changes
  6. Commit with clear messages
  7. Push and create a Pull Request

Copyright Notice for New Files

Add this header to the top of any new source files:

/*
 * tdeo - Code typing playback for VS Code
 * Copyright (C) 2025 tdeo contributors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */

Code Style

  • No excessive comments
  • Self-explanatory code
  • Descriptive function and variable names
  • Keep functions focused and small
  • Run npm run lint before committing

Testing

  • Test with F5 in VS Code (Extension Development Host)
  • Try different file types
  • Test all :tdeo commands
  • Verify status bar and buttons behave correctly

Development Setup

git clone https://github.com/your-username/tdeo.git
cd tdeo
npm install
npm run compile

Press F5 in VS Code to launch the extension in debug mode.

Questions?

Open an issue for any questions about contributing.