botserver/docs/src/chapter-13-community/README.md

73 lines
1.7 KiB
Markdown
Raw Normal View History

2025-12-01 02:22:35 -03:00
# Chapter 13: Contributing
2025-11-24 13:02:30 -03:00
2025-12-01 02:22:35 -03:00
Join the General Bots community and help improve the platform.
2025-11-24 13:02:30 -03:00
2025-12-01 02:22:35 -03:00
## Quick Links
2025-11-24 13:02:30 -03:00
2025-12-01 02:22:35 -03:00
| Resource | Purpose |
|----------|---------|
| [GitHub](https://github.com/GeneralBots/botserver) | Source code, issues |
| [Discussions](https://github.com/GeneralBots/botserver/discussions) | Q&A, ideas |
| [Blog](https://pragmatismo.com.br/blog) | Updates, tutorials |
2025-11-24 13:02:30 -03:00
2025-12-01 02:22:35 -03:00
## How to Contribute
2025-11-24 13:02:30 -03:00
### Code Contributions
2025-12-01 02:22:35 -03:00
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Write tests
5. Submit a pull request
2025-11-24 13:02:30 -03:00
### Documentation
2025-12-01 02:22:35 -03:00
- Fix typos and errors
- Add examples
- Improve clarity
- Translate content
2025-11-24 13:02:30 -03:00
2025-12-01 02:22:35 -03:00
### Community Support
2025-11-24 13:02:30 -03:00
2025-12-01 02:22:35 -03:00
- Answer questions in discussions
- Share your bots and templates
- Report bugs with reproduction steps
- Suggest features
2025-11-24 13:02:30 -03:00
2025-12-01 02:22:35 -03:00
## Development Setup
2025-11-24 13:02:30 -03:00
2025-12-01 02:22:35 -03:00
```bash
git clone https://github.com/GeneralBots/botserver
cd botserver
cargo build
./target/debug/botserver
2025-11-24 13:02:30 -03:00
```
2025-12-01 02:22:35 -03:00
## What We Accept
2025-11-24 13:02:30 -03:00
2025-12-01 02:22:35 -03:00
✅ Bug fixes with tests
✅ Performance improvements
✅ New BASIC keywords (if broadly useful)
✅ Documentation improvements
✅ Security enhancements
2025-11-24 13:02:30 -03:00
2025-12-01 02:22:35 -03:00
## What We Don't Accept
2025-11-24 13:02:30 -03:00
2025-12-01 02:22:35 -03:00
❌ Vendor-specific integrations
❌ Undocumented code
❌ Code without tests
❌ Features achievable with existing BASIC + LLM
2025-11-24 13:02:30 -03:00
2025-12-01 02:22:35 -03:00
## Chapter Contents
2025-11-24 13:02:30 -03:00
2025-12-01 02:22:35 -03:00
- [Development Setup](./setup.md) - Build environment
- [Testing Guide](./testing.md) - Running tests
- [Documentation](./documentation.md) - Writing docs
- [Pull Requests](./pull-requests.md) - PR process
- [Community Guidelines](./community.md) - Code of conduct
- [IDEs](./ide-extensions.md) - Editor support
2025-11-24 13:02:30 -03:00
## See Also
2025-12-01 02:22:35 -03:00
- [Architecture](../chapter-07-gbapp/README.md) - System design
- [BASIC Reference](../chapter-06-gbdialog/README.md) - Scripting language