Developer Guidelines

General Coding Practices

• Write clean, readable, and well-documented code
• Follow the principle of least surprise - code should behave as users expect
• Keep methods and classes focused on a single responsibility
• Optimize for performance, especially for server-side operations
• Include appropriate error handling and logging
• Write unit tests for critical functionality

Java/Bukkit Plugin Standards

• Follow Java naming conventions (camelCase for methods and variables, PascalCase for classes)
• Properly handle plugin enable/disable events
• Use the Bukkit API correctly and efficiently
• Avoid blocking the main thread with heavy operations
• Implement proper permission systems
• Include clear configuration files with comments
• Support reload functionality when possible

Plugin Structure

• Include a well-formatted plugin.yml file
• Organize your code into logical packages
• Separate concerns (commands, listeners, data management, etc.)
• Use dependency injection or service locator patterns for complex plugins
• Include a README.md with installation and usage instructions
• Document configuration options thoroughly

Preparing Your Plugin

1. Ensure your plugin meets all code standards
2. Test thoroughly on multiple server versions
3. Create clear documentation including:
   • Installation instructions
   • Configuration guide
   • Command reference
   • Permissions list
4. Prepare high-quality screenshots or videos showcasing your plugin
5. Create a compelling description that clearly explains your plugin's features and benefits

Submission Requirements

• Your plugin must be original work or properly licensed
• Include all source code or link to a public repository
• Specify compatible Minecraft versions
• List all dependencies
• Choose an appropriate license (we recommend GPL, MIT, or Apache 2.0)
• Provide contact information for support inquiries

Update Process

• Maintain a changelog for all updates
• Test updates thoroughly before submission
• Ensure backward compatibility when possible
• Provide migration guides for breaking changes
• Respond promptly to user feedback and bug reports

What We Look For

• Code quality and adherence to standards
• Originality and usefulness
• Performance and resource usage
• User experience and interface design
• Documentation quality
• Security considerations

Review Timeline

Our review process typically follows these steps:

1. Initial submission review (1-3 business days)
2. Code review and testing (3-7 business days)
3. Feedback and requested changes (if necessary)
4. Final approval and publication

The entire process usually takes 1-2 weeks, depending on the complexity of your plugin and our current review queue.

Being a Good Community Member

• Respond to user questions and issues in a timely manner
• Maintain a respectful and professional attitude
• Collaborate with other developers when appropriate
• Share knowledge and help others improve
• Accept constructive criticism gracefully
• Give credit to others when building upon their work

Support Expectations

• Provide clear channels for support (forum, Discord, GitHub issues, etc.)
• Aim to respond to support requests within 48 hours
• Maintain your plugins with regular updates
• Clearly communicate when a plugin is no longer being maintained
• Consider creating documentation or FAQs for common issues