alfred-agent/CONTRIBUTING.md
2026-04-07 17:07:35 -04:00

1.1 KiB

Contributing to Alfred Agent

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.