Skip to main content

🌟 Contributing 101

This section is for people interested in contributing to PearAI 🍐​

We welcome contributions from the community! Whether you're fixing a bug, improving the documentation, or adding a new feature, we appreciate your help in making PearAI better. There is a lot of context involved and we understand it can be overwhelming when first trying to join the project. Here is a quick summary of key information and how we currently work together:

  • Pan and Nang conduct "Quests", which are 1-3 weeks sprints. We will pick out the current highest priority issues for these quests, ping everyone in our Discord, and ask for applications to participate in them. The chosen people will help finish the tasks alongside us, participating in calls and working together. If help is needed, we may add more people to the quest.
  • Outside of dedicated Quests, we also have a bunch of issues (good first ones) which are free to tackle. Make sure to leave a comment indicating you're working on it (check for existing comments also). You can raise a PR anytime and we usually review them pretty quickly. Feel free to also contribute improvements outside of existing issues.
  • We have a lot on our plate so it's easy for us to miss something. The best way to get our attention is to ping us directly in our Discord server.

Please review our coding Contributing Guide to set up your coding environment. If you prefer a video, you can check out this tutorial for how to setup the pearai-app repository and run the app locally. For any questions, join the PearAI Discord!

For a complete onboarding to being a PearAI contributor, see this onboarding presentation.

For quick access to all links regarding PearAI, save this Master Doc.

Curious about our stack?

  • PearAI is built with Electron.js.
  • PearAI landing page is Next.js/React with Supabase auth (TailwindCSS + Shadcn).
  • PearAI backend is a Python FastAPI server with Supabase database.
  • Logging/Telemetry is done with Axiom.

For Mac users: Download the Development Version of PearAI​

To run PearAI in development mode, you need to download the unnotarized version of the app since the notarized version cannot run in debug mode.

Download Development Version of PearAI Here

Contributors​

Thanks to this list of wonderful people who've contributed to PearAI!