53 lines
1.7 KiB
Markdown
53 lines
1.7 KiB
Markdown
# Contributing to Kan
|
|
|
|
Thank you for your interest in contributing to Kan! This document provides guidelines and instructions for contributing to the project.
|
|
|
|
## Getting Started
|
|
|
|
1. Fork the repository
|
|
2. Clone your fork: `git clone https://github.com/YOUR-USERNAME/kan.git`
|
|
3. Create a new branch: `git checkout -b feat/your-feature-name`
|
|
4. Install dependencies: `pnpm install`
|
|
5. Copy `.env.example` to `.env` and configure your environment variables
|
|
6. Make your changes
|
|
7. Commit your changes: `git commit -m "feat: description of changes"`
|
|
8. Push to your fork: `git push origin feat/your-feature-name`
|
|
9. Open a Pull Request
|
|
|
|
## Development Guidelines
|
|
|
|
### Code Style
|
|
|
|
- Follow the existing code style
|
|
- Use meaningful variable and function names
|
|
- Add comments for complex logic
|
|
- Keep functions focused and concise
|
|
|
|
### Commits
|
|
|
|
- Use clear and descriptive commit messages
|
|
- Reference issue numbers when applicable
|
|
- Keep commits focused on single changes
|
|
|
|
### Pull Requests
|
|
|
|
- Provide a clear description of the changes
|
|
- Include screenshots for UI changes
|
|
- Keep PRs focused on a single feature/fix
|
|
|
|
## Need Help?
|
|
|
|
- Join our [Discord server](https://discord.gg/e6ejRb6CmT) for questions
|
|
- Check existing issues and pull requests
|
|
- Email [henry@kan.bn](mailto:henry@kan.bn) for major concerns
|
|
|
|
## Code of Conduct
|
|
|
|
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.
|
|
|
|
## License
|
|
|
|
By contributing to Kan, you agree that your contributions will be licensed under the AGPLv3 License.
|