Skip to content

Open-source and local-first Slack and Notion alternative that puts you in control of your data

Add contributing and security docs (#300)

Ylber Gashicc72b3e2a145
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..d60bb7c6
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,45 @@
+# Contributing to Colanode
+
+Thanks for taking the time to contribute! Colanode is an open-source, local-first collaboration platform with web, desktop, and server components. We welcome bug reports, feature requests, docs improvements, and code contributions.
+
+## Before you start
+
+Before making any significant changes, please open an issue to discuss the proposal. Talking through changes early helps keep the contribution process smooth for everyone.
+
+## Ways to contribute
+
+- Report bugs and regressions
+- Propose features or improvements
+- Improve documentation
+- Submit code changes
+
+## Development setup (quick pointers)
+
+See the main [README.md](README.md) for full local setup details:
+
+- Root setup: `npm install`
+- Server: `apps/server` (uses Postgres + Redis; Docker Compose is provided)
+- Web: `apps/web`
+- Desktop: `apps/desktop`
+- Mobile: `apps/mobile` (experimental; not ready for production use)
+- Scripts: see [scripts/README.md](scripts/README.md) for emojis, icons, and seed data
+
+Notes:
+
+- `npm install` runs a `postinstall` step that generates/copies emoji and icon assets into the apps.
+- These generated asset outputs are intentionally ignored by git; please don’t add them to commits (focus on source changes under `scripts/` instead).
+
+## Tests
+
+Currently we don't have any tests. If you change behavior, please include clear manual verification steps in your PR description and run `npm run build` when relevant before opening a PR.
+
+## Pull request process
+
+- Fork the repo and branch from `main`.
+- Keep PRs focused and scoped to a single change when possible.
+- Update or add docs if your change affects usage or setup.
+- For UI changes, include screenshots or a short video.
+
+## License
+
+By contributing, you agree that your contributions are licensed under the Apache 2.0 License (see `LICENSE`).
diff --git a/SECURITY.md b/SECURITY.md
new file mode 100644
index 00000000..b1c0a220
--- /dev/null
+++ b/SECURITY.md
@@ -0,0 +1,19 @@
+# Security Policy
+
+Colanode takes security seriously. If you discover a vulnerability, please report it privately and avoid public disclosure until we’ve had a chance to investigate.
+
+## Reporting a vulnerability
+
+- Preferred: Use GitHub Security Advisories for this repository to submit a private report.
+- If you cannot use GitHub Security Advisories, contact the maintainers via the email listed on the Colanode GitHub organization profile.
+
+Please include:
+
+- A clear description of the issue and its impact.
+- Steps to reproduce (including any relevant configuration).
+- A proof of concept, if available.
+- Affected components (server, web, desktop, mobile) and versions/commits.
+
+## What to expect
+
+We’ll acknowledge receipt and work on a fix. Coordinated disclosure helps protect users—thank you for reporting responsibly.