31 lines
1.1 KiB
Markdown
31 lines
1.1 KiB
Markdown
# Contributing to Alfred Agent
|
|
|
|
## Quick Links
|
|
|
|
- **Bug reports:** [GoForge Issues](https://alfredlinux.com/forge/commander/alfred-agent/issues)
|
|
- **All repos:** [GoForge](https://alfredlinux.com/forge/explore/repos)
|
|
- **Community:** [alfredlinux.com/community](https://alfredlinux.com/community)
|
|
|
|
## Reporting Bugs
|
|
|
|
Open an issue on GoForge. Include the provider (Anthropic/OpenAI/Groq), model, error message, and steps to reproduce.
|
|
|
|
## Contributing Code
|
|
|
|
1. Fork the repo on GoForge
|
|
2. Clone your fork and create a topic branch
|
|
3. Make your change — keep commits focused
|
|
4. Test: `node src/cli.js --provider openai --model gpt-4o-mini -m "test"`
|
|
5. Push and open a Pull Request
|
|
|
|
### Architecture Notes
|
|
|
|
- `src/agent.js` — Core agent loop. Changes here affect all providers.
|
|
- `src/tools.js` — Adding a tool? Follow the existing pattern: name, description, parameters, execute function.
|
|
- `src/providers.js` — Adding a provider? Implement the same interface as the OpenAI adapter.
|
|
- No external frameworks. Pure Node.js. Keep it that way.
|
|
|
|
## License
|
|
|
|
Contributions are licensed under [AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html).
|