Documentation

Developers

Polar is Open Source

Polar is proudly built open source (Apache 2.0). You can find our entire product & docs on our GitHub

You can develop on Polar in GitHub Codespaces. The environment is pre-configured to contain (most) of the tools that you'll need, and will help you to configure the integration between Polar and GitHub (see .devcontainer/README). Using an instance with at least 4 cores is recommended.

Open in GitHub Codespaces

You can also develop on Polar locally on your computer. It's the recommended way of working if you want to make contributions on a regular basis.

Documentation on how to setup a development environment is incoming. Until then, if you're feeling adventurous checkout our repository structure below and clients/README and server/README in particular.

note

Join our Discord to chat with the core team and other contributors.

Contributors

Roadmap, Issues & Feature Requests

🎯 v1.0 North Star. Checkout what we're building towards

💬 Shape the future of Polar with us. Join our Discord

🐛 Found a bug? Submit it here.

🔓 Found a security vulnerability? We greatly appreciate responsible and private disclosures to [email protected]. See Security

Security

If you believe you have found a security vulnerability in Polar, we encourage you to responsibly disclose this and not open a public issue. We will investigate all legitimate reports and greatly appreciate your help. Email [email protected] to disclose any security vulnerabilities.