Contributing to Skill Porter

Thank you for considering contributing to Skill Porter! This project aims to make cross-platform AI tool development easier for everyone.

How to Contribute

Reporting Issues

Use the GitHub issue tracker
Describe the issue clearly with examples
Include version information and platform details
Provide sample code or skills/extensions that reproduce the issue

Suggesting Features

Open an issue with the "enhancement" label
Describe the feature and its use case
Explain how it would benefit the community

Submitting Pull Requests

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Make your changes
Test thoroughly (both Claude and Gemini conversions)
Commit with clear messages (git commit -m 'Add amazing feature')
Push to your fork (git push origin feature/amazing-feature)
Open a Pull Request

Development Setup

# Clone your fork
git clone https://github.com/YOUR-USERNAME/skill-porter
cd skill-porter

# Install dependencies
npm install

# Run tests
npm test

# Test CLI locally
node src/cli.js analyze ../path/to/skill

Testing Guidelines

When adding features or fixing bugs:

Test with Claude skills conversion to Gemini
Test with Gemini extensions conversion to Claude
Test with universal skills/extensions
Verify validation passes for generated files
Check that MCP server configurations are preserved

Code Style

Use ES modules (import/export)
Follow existing code structure
Add JSDoc comments for public APIs
Keep functions focused and single-purpose
Use meaningful variable names

Adding Platform Support

If you're adding support for a new platform or feature:

Update the detector in src/analyzers/detector.js
Add conversion logic in src/converters/
Update validation in src/analyzers/validator.js
Update documentation and README
Add examples to examples/ directory

Questions?

Open an issue or start a discussion. We're here to help!

License

By contributing, you agree that your contributions will be licensed under the MIT License.

2.1 KiB Raw Blame History