Contributing to CLIcraft

Thank you for your interest in contributing to CLIcraft! We welcome contributions from the community and appreciate your help in making this tool better.

🚀 Quick Links

• Full Contributing Guide: CONTRIBUTING.md
• Issue Tracker: GitHub Issues
• Pull Requests: GitHub PRs
• Repository: theinfamousben/clicraft

📋 Ways to Contribute

There are many ways you can contribute to CLIcraft:

🐛 Report Bugs

Found a bug? Please open an issue with:

• A clear description of the problem
• Steps to reproduce the issue
• Your environment (OS, Node.js version, etc.)
• Expected vs actual behavior

✨ Suggest Features

Have an idea for a new feature? We’d love to hear it! Open an issue and describe:

• What problem the feature would solve
• How you envision it working
• Any examples or mockups (if applicable)

📝 Improve Documentation

Documentation improvements are always welcome:

• Fix typos or clarify existing docs
• Add examples or use cases
• Write tutorials or guides
• Improve code comments

💻 Submit Code

Ready to write some code? Here’s how to get started:

1. Fork the repository and clone it locally
2. Set up your development environment (see below)
3. Create a branch for your changes
4. Make your changes following our coding guidelines
5. Test your changes thoroughly
6. Submit a pull request with a clear description

🛠️ Development Setup

Prerequisites

• Node.js 18 or higher
• Java 21 or higher (for testing Minecraft functionality)
• Git

Quick Setup

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

# Install dependencies
npm install

# Link globally for testing
npm link

# Verify installation
clicraft --version

📖 Detailed Guide

For a comprehensive guide on contributing, including:

• Code style guidelines
• Pull request process
• Testing procedures
• Best practices

Please read our full Contributing Guide.

🤝 Code of Conduct

We are committed to providing a welcoming and inclusive environment. Please:

• Be respectful and constructive
• Welcome and help newcomers
• Provide helpful feedback
• Be patient and understanding

💬 Getting Help

Need help getting started?

• Check the Installation Guide
• Review the Commands Documentation
• Ask questions in GitHub Issues

📜 License

By contributing to CLIcraft, you agree that your contributions will be licensed under the ISC License.

---

Ready to contribute? Check out our full Contributing Guide to get started!