UNPKG

shipdeck

Version:

Ship MVPs in 48 hours. Fix bugs in 30 seconds. The command deck for developers who ship.

93 lines (68 loc) 2.43 kB
# Contributing to Shipdeck First off, thank you for considering contributing to Shipdeck! It's people like you that make Shipdeck such a great tool for developers who ship fast. ## 🚀 Quick Start 1. Fork the repo 2. Clone your fork 3. Create a branch 4. Make your changes 5. Push to your fork 6. Open a PR ## 🤝 Code of Conduct - Be respectful and inclusive - Welcome newcomers and help them get started - Focus on what's best for the community - Show empathy towards other community members ## 💡 What Can I Contribute? ### Bug Reports Found a bug? Open an issue with: - Clear description - Steps to reproduce - Expected vs actual behavior - System info (OS, Node version) ### Feature Requests Have an idea? We'd love to hear it! Open an issue with: - Problem it solves - Proposed solution - Alternative solutions considered ### Code Contributions - **Bug fixes** - Pick an issue labeled `bug` - **Features** - Pick an issue labeled `enhancement` - **Documentation** - Always needed! - **Tests** - Help us increase coverage ## 🛠️ Development Setup ```bash # Clone your fork git clone https://github.com/YOUR_USERNAME/shipdeck.git cd shipdeck # Install dependencies npm install # Run tests npm test # Test the CLI locally npm link shipdeck --help ``` ## 📝 Pull Request Process 1. **Branch naming**: `feature/your-feature` or `fix/your-fix` 2. **Commits**: Use conventional commits (`feat:`, `fix:`, `docs:`) 3. **Tests**: Add tests for new features 4. **Documentation**: Update README if needed 5. **PR Description**: Clearly describe what and why ## 🎯 Our Standards - **Code Style**: Use existing patterns - **Simplicity**: Simple solutions are better - **Performance**: Keep it fast - **User Experience**: Ship beats perfect ## 🏷️ Issue Labels - `good-first-issue` - Perfect for beginners - `help-wanted` - We need your help! - `bug` - Something isn't working - `enhancement` - New feature or request - `documentation` - Documentation improvements ## ❓ Questions? - Join our [Discord](https://shipdeck.ai/discord) - Tweet us [@shipdeckai](https://twitter.com/shipdeckai) - Open a [Discussion](https://github.com/shipdeckai/shipdeck/discussions) ## 🙏 Thank You! Every contribution helps make Shipdeck better. Whether it's fixing a typo, adding a feature, or helping someone in Discord - you're helping developers ship faster. **Ship beats perfect. Let's ship together!**