Skip to content

Latest commit

 

History

History
93 lines (59 loc) · 1.85 KB

File metadata and controls

93 lines (59 loc) · 1.85 KB

🤝 Contributing to Basely

Thanks for your interest in contributing!

Basely is part of BuildBaseKit — focused on clean, production-ready backend boilerplates.
This project provides a structured foundation for building Discord bots using Spring Boot.

We welcome contributions that improve clarity, extensibility, and real-world usability.


🚀 How to Contribute

1. Fork the Repository

Create your own fork and clone it locally.

2. Create a Branch

Use clear naming:

  • feature/new-command-system
  • fix/event-handler-bug
  • docs/readme-update

3. Make Changes

Keep changes:

  • minimal and focused
  • aligned with existing architecture (commands, events, services)
  • easy to understand and extend

4. Test Your Changes

Ensure:

  • Bot starts successfully
  • Commands and events work correctly
  • No existing functionality breaks

5. Submit a Pull Request

Include:

  • clear description
  • what problem it solves
  • how to test it

📌 Contribution Guidelines

  • Follow existing project structure
  • Keep command/event handling clean and modular
  • Avoid unnecessary abstractions
  • Write readable and maintainable code
  • Use meaningful commit messages

💡 What You Can Contribute

  • New command examples
  • Event handling improvements
  • Better configuration management
  • Logging and monitoring improvements
  • Documentation improvements

🚫 What Not to Do

  • Do not over-engineer the architecture
  • Do not introduce heavy dependencies unnecessarily
  • Do not commit secrets (Discord token, DB credentials, etc.)

🧠 Philosophy

Structure over chaos
Simple over clever
Extendable over rigid


🌐 BuildBaseKit

This project is part of BuildBaseKit
👉 https://buildbasekit.com


Clean contributions make this boilerplate better for everyone.