AgenticAPI thrives on community contributions, and we welcome developers, API designers, and AI enthusiasts to help shape the future of action-oriented APIs. Whether you’re fixing bugs, adding verbs, improving documentation, or proposing features, your contributions make AgenticAPI better for everyone. This guide outlines how to get involved and contribute effectively.

Ways to Contribute #

There are many ways to contribute to AgenticAPI, no matter your skill level:

• Code Contributions: Add new verbs (e.g., CHECK, VALIDATE), enhance endpoints, or fix bugs in the FastAPI codebase.
• Documentation: Improve clarity, add examples, or translate docs in our markdown files.
• Feature Proposals: Suggest new verbs, categories, or extensions to support agent-driven workflows.
• Bug Reports: Identify issues with endpoints, verbs, or schemas, providing reproducible steps.
• Community Support: Answer questions in our upcoming forum (planned for v0.4.0) or share tutorials.

Getting Started #

1. Explore the Project:
   • Review What is AgenticAPI? for an overview.
   • Check API Endpoints and Verb References for technical details.
2. Set Up Your Environment:
   • Follow Installation to install dependencies.
   • Use the Project Structure guide to organize your workspace.
3. Find an Issue:
   • Check our issue tracker (planned for v0.4.0) for open tasks.
   • Look for documentation gaps or verb ideas in Verb References.
   • Email support@agenticapi.io to discuss contribution ideas.
4. Submit Contributions:
   • Code: Fork the repository (planned for v0.4.0), create a branch, and submit a pull request with clear descriptions.
   • Documentation: Update markdown files in the docs/ folder and submit changes.
   • Feedback: Use the Feedback Form or email for proposals.

Contribution Guidelines #

• Code Quality:
  • Follow Python PEP 8 style guidelines.
  • Use Pydantic for schemas and FastAPI for endpoints.
  • Include unit tests in test_main.py for new features.
• Documentation:
  • Write clear, concise markdown with examples.
  • Link to related sections (e.g., Verb References).
  • Use consistent terminology (e.g., “action verb,” “intent modifier”).
• Proposals:
  • Describe the problem, solution, and use case.
  • Align with the ACTION framework (Acquire, Compute, etc.).
  • Discuss via email before major changes.
• Respect the Community:
  • Be inclusive, respectful, and collaborative.
  • Follow our Code of Conduct (planned for v0.4.0).

Recognition #

Contributors are recognized in our Roadmap updates and future release notes. Significant contributions may be highlighted in our blog or newsletter (coming soon).

Next Steps #

• Contact us at Contact Us to start contributing.
• Check our Roadmap for project priorities.
• Explore Quick Start to begin development.