Thank you for your interest in contributing to Kan! This document provides guidelines and instructions for contributing to the project.
- Fork the repository
- Clone your fork:
git clone https://github.com/YOUR-USERNAME/kan.git - Create a new branch:
git checkout -b feat/your-feature-name - Install dependencies:
pnpm install - Copy
.env.exampleto.envand configure your environment variables - Make your changes
- Commit your changes:
git commit -m "feat: description of changes" - Push to your fork:
git push origin feat/your-feature-name - Open a Pull Request
- Follow the existing code style
- Use meaningful variable and function names
- Add comments for complex logic
- Keep functions focused and concise
- Use clear and descriptive commit messages
- Reference issue numbers when applicable
- Keep commits focused on single changes
- Provide a clear description of the changes
- Include screenshots for UI changes
- Keep PRs focused on a single feature/fix
- Join our Discord server for questions
- Check existing issues and pull requests
- Email [email protected] for major concerns
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
We aim to foster an inclusive and welcoming community. Harassment and abusive behavior will not be tolerated.
By contributing to Kan, you agree that your contributions will be licensed under the AGPLv3 License.