contributing.md

Contributing to Akeru.ai

Welcome to the Akeru.ai community! We are thrilled to have you onboard. This document is designed to ensure that your contributions to our open-source AI platform are as smooth and effective as possible.

Table of Contents

1. Legal and Licensing
2. Project Overview and Code of Conduct
3. Getting Started
4. Contribution Process
5. Coding Conventions
6. Building and Testing
7. Documentation Standards
8. Handling Issues and Pull Requests
9. Community and Communication
10. Recognition and Rewards
11. Accessibility Guidelines
12. Internationalization
13. Security Practices

Legal and Licensing

Akeru.ai is released under the MIT License. It is important to understand how this affects your contributions. Read the full license here.

Project Overview and Code of Conduct

Akeru.ai is an API platform that offers transparent, safe, and highly available AI capabilities. We strive to maintain a welcoming and inclusive community.

Our Code of Conduct outlines expected behavior and practices to ensure a collaborative and respectful environment.

Getting Started

Setting up your development environment is the first step in contributing:

• Platform Setup Guide: Additional setup instructions for the platform will be provided soon.

Contribution Process

To contribute to Akeru.ai:

1. Fork the repository on GitHub.
2. Clone your fork to your local machine (git clone url).
3. Create a branch for your changes (git checkout -b feature-branch-name).
4. Make your changes and commit them (git commit -am 'Add some feature').
5. Push your branch to your fork (git push origin feature-branch-name).
6. Create a pull request against our main branch.

Coding Conventions

Akeru.ai follows Next.js linting standards in the Next app and plans to setup ESLint for the API and service mesh parts. For coding styles, we use Prettier. Our Prettier config will serve as the source of truth. View the full coding convention here.

Building and Testing

• Website: Automated by Vercel.
• API: Currently under development for automated processes.

Documentation Standards

All contributions should include relevant documentation updates:

• Formatting Guidelines: Follow our documentation style guide here.
• Where to Add Documentation: Add to /docs or inline as appropriate.

Handling Issues and Pull Requests

• Reporting Issues: Use our template here. Ensure to include the detailed steps to reproduce the issue.
• Pull Requests: Use our PR template, link related issues, and provide a detailed description of your changes. Check that out here

Community and Communication

Join the conversation on [Discord] and stay updated:

• Main Channels: [Links to communication platforms]
• Communication Norms: Engage respectfully and frequently to collaborate effectively.

Recognition and Rewards

Details on contributor recognition and rewards are currently being developed.

Accessibility Guidelines

We are committed to making our project accessible and plan to enhance this by adding specific linting rules. Current Next.js accessibility rules are a good baseline.

Internationalization

Plans are in development and will be documented accordingly.

Security Practices

Detailed security protocols will be added upon completion.