🤝 Contributing to PortaPack

🌟 Ways to Contribute

1. Code Improvements
2. Bug Fixes
3. Documentation Enhancements
4. Feature Development
5. Testing and Quality Assurance

📋 Contribution Guidelines

🛠 Setup

Refer to our detailed Development Guide for comprehensive setup instructions.

🧪 Development Workflow

1. Fork the Repository

   • Navigate to PortaPack GitHub Repository
   • Click "Fork"

2. Clone Your Fork

   git clone https://github.com/YOUR_USERNAME/portapack.git
   cd portapack

3. Create a Branch

   git checkout -b feature/your-feature-name
   # or
   git checkout -b bugfix/issue-description

📝 Commit Guidelines

We use Conventional Commits for structured commit messages.

Commit Types

• feat: New features
• fix: Bug fixes
• docs: Documentation changes
• style: Code formatting
• refactor: Code restructuring
• test: Test-related changes
• chore: Maintenance tasks

Commit Command

npm run commit

🧪 Before Submitting a Pull Request

# Run tests
npm test

# Lint code
npm run lint

# Format code
npm run format

📤 Pull Request Process

1. Ensure all tests pass
2. Update documentation if needed
3. Add description of changes
4. Link any related issues

🏆 Contributor Recognition

• Contributors are listed in CONTRIBUTORS.md
• Significant contributions may be highlighted in release notes

📋 Code of Conduct

Please review our Code of Conduct before contributing.

🚨 Reporting Issues

• Use GitHub Issues
• Provide detailed description
• Include reproduction steps
• Share relevant code snippets or error logs

🛡️ Security Vulnerabilities

• Do NOT open public issues for security vulnerabilities
• Email security details to security@portapack.dev
• Include reproduction steps
• Allow time for responsible disclosure

💬 Community

• Join our Discord Community
• Follow us on Twitter
• Use GitHub Discussions for ideas and questions

🙌 Thank You!

Open source thrives on community contributions. Your effort helps improve PortaPack for everyone! 🎉

Happy Coding! 💻✨