From c1b38fadefbe83e9c0bcd21db93e5b99763bf1c5 Mon Sep 17 00:00:00 2001
From: Henry <henry_ball@hotmail.co.uk>
Date: Thu, 29 May 2025 13:13:40 +0100
Subject: [PATCH] feat: update readme add contributing.md

---
 CONTRIBUTING.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       | 46 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 98 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..d21bdc89
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,52 @@
+# 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.
diff --git a/README.md b/README.md
index 92476be5..b7f3c9d5 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,19 @@
   <a href="https://github.com/kanbn/kan/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-AGPLv3-purple"></a>
 </div>
 
+### Features 💫
+
+- 👁️ **Board Visibility**: Control who can view and edit your boards
+- 🤝 **Workspace Members**: Invite members and collaborate with your team
+- 🚀 **Trello Imports**: Easily import your Trello boards
+- 🔍 **Labels & Filters**: Organise and find cards quickly
+- 💬 **Comments**: Discuss and collaborate with your team
+- 📝 **Activity Log**: Track all card changes with detailed activity history
+- 🎨 **Templates (coming soon)** : Save time with reusable board templates
+- ⚡️ **Integrations (coming soon)** : Connect your favourite tools
+
+See our [roadmap](https://kan.bn/kan/roadmap) for upcoming features.
+
 ### Made With 🛠️
 
 - [Next.js](https://nextjs.org/?ref=kan.bn)
@@ -27,3 +40,36 @@
 - [Tailwind CSS](https://tailwindcss.com/?ref=kan.bn)
 - [Drizzle ORM](https://orm.drizzle.team/?ref=kan.bn)
 - [React Email](https://react.email/?ref=kan.bn)
+
+### Local Development 🛠️
+
+1. Clone the repository (or fork)
+
+```bash
+git clone https://github.com/kanbn/kan.git
+```
+
+2. Install dependencies
+
+```bash
+pnpm install
+```
+
+3. Copy `.env.example` to `.env` and configure your environment variables
+4. Start the development server
+
+```bash
+pnpm dev
+```
+
+### Contributing 🤝
+
+We welcome contributions! Please read our [contribution guidelines](CONTRIBUTING.md) before submitting a pull request.
+
+### License 📝
+
+Kan is licensed under the [AGPLv3 license](LICENSE).
+
+### Contact 📧
+
+For support or to get in touch, please email [henry@kan.bn](mailto:henry@kan.bn) or join our [Discord server](https://discord.gg/e6ejRb6CmT).