CONTRIBUTING.md

Contributing to Kaneo

Thank you for your interest in contributing to Kaneo! All kinds of contributions are valuable to us. This guide will help you get started with the contribution process.

Table of Contents

• Code of Conduct
• Getting Started
  • Requirements
  • Local Development Setup
• Making Contributions
  • Finding Issues to Work On
  • Creating Pull Requests
• Development Guidelines
  • Code Style
  • Conventional Commits
  • Project Structure
• Need Help?

Code of Conduct

We are a community-driven project and we expect all contributors to follow our Code of Conduct. Please read it before participating. Code of Conduct

Getting Started

Requirements

• Docker
• Docker Compose
• Git

Local Development Setup

1. Fork and clone the repository:

git clone https://github.com/kaneo-app/app.git

2. Install the dependencies:

bun install

3. Add JWT_ACCESS environment variable:

echo "JWT_ACCESS=<token>" > apps/api/.env

4. Start the development server:

bun run dev

This will start the frontend and backend servers on http://localhost:5173 and http://localhost:1337 respectively.

Making Contributions

Finding Issues to Work On

• Check the issues page for open issues.
• Check the Discord server for help with issues.

Creating Pull Requests

• Create a new branch for your changes.
• Make your changes and commit them using conventional commits:

git commit -m "feat: add new feature"

• Push your changes to your fork.

git push origin my-branch

• Create a pull request.

Development Guidelines

Code Style

• Use biome for code style and linting.
• The project is configured with Biome's recommended rules.
• Run bun x biome ci . before committing to ensure your code follows the style guide.

Conventional Commits

• Use conventional commits for commit messages.
• Common types: feat, fix, docs, style, refactor, test, chore

Project Structure

• apps/api/: The backend API server.
• apps/web/: The frontend web application.
• packages/: Shared packages and configurations.

Need Help?

• Check the Discord server for help.
• Open an issue if you need help.

Thank you for your contribution to Kaneo! 🎉