Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (29 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 1.42 KB

Contributing to Comment Cleaner Pro

Thank you for your interest in contributing to Comment Cleaner Pro! This document provides guidelines and instructions for contributing.

Development Setup

  1. Fork and clone the repository
  2. Install dependencies: npm install
  3. Build the extension: npm run build
  4. Launch the extension in debug mode: F5 in VS Code

Code Structure

  • src/: Main TypeScript source code
  • python/: Python code for comment processing
  • media/: Images and other media files

Pull Request Process

  1. Create a feature branch from main
  2. Make your changes following the coding standards
  3. Add tests for your changes
  4. Update documentation as needed
  5. Submit a pull request with a clear description of the changes

Coding Standards

  • Use TypeScript for all extension code
  • Follow the established code style (ESLint configuration)
  • Write unit tests for new functionality

Testing

Run tests with: npm test

Licensing Notice

By contributing to Comment Cleaner Pro, you agree that your contributions will be licensed under the project's GPL-3.0 license. All contributions must:

  1. Maintain the original copyright and license notices
  2. Clearly attribute Comment Cleaner Pro and its original author (Christlieb Dela)
  3. Remain open source under the same GPL-3.0 license

This ensures that the project and all derivatives remain free and open source while properly crediting the original work.