84 lines (59 loc) · 1.69 KB

Contributing to License Guard

First off, thank you for considering contributing to License Guard! 🎉

🚀 Quick Start

Fork the repository
Clone your fork: git clone https://github.com/YOUR_USERNAME/license-guard.git
Install dependencies: npm install
Create a branch: git checkout -b feature/amazing-feature
Make your changes
Test: npm test
Commit: git commit -m 'Add amazing feature'
Push: git push origin feature/amazing-feature
Open a Pull Request

📋 Development Setup

# Install dependencies
npm install

# Run the CLI locally
node src/cli.js scan

# Run tests
npm test

# Lint code
npm run lint

🧪 Testing

Please add tests for any new features. We use Node.js built-in test runner.

npm test

📝 Commit Messages

We follow Conventional Commits:

feat: - New features
fix: - Bug fixes
docs: - Documentation changes
test: - Test additions/changes
refactor: - Code refactoring
chore: - Maintenance tasks

Examples:

feat: add support for Cargo.toml scanning
fix: handle missing LICENSE files gracefully
docs: improve API documentation

🐛 Bug Reports

Please include:

Node.js version
Operating system
Steps to reproduce
Expected vs actual behavior

💡 Feature Requests

Open an issue with:

Clear description of the feature
Use case / why it's needed
Any implementation ideas

📜 Code of Conduct

Be kind and respectful. We're all here to make great software together.

📄 License

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

Thank you for helping make License Guard better! 💖