faq.md

How do I contribute?

Get started with our README. You can visit this set of docs for more details when you're up and running.

Actually, I meant how to contribute to these cool docs!

All documentation lives in the docs folder. Any guides and clarifications are very much welcome.

I'm getting an error [SOME-ERROR]. Where do I report it?

You can write a new issue and let us know what exactly what went wrong. We'll be able to help you debug if we have specific information, the context of how the error happened, and any other information you think would help.

How do I setup the repo with Windows/Linux/Ubuntu/not macOS?

Unfortunately, the core team develops only macOS right now. We don't have guidelines for other operating systems yet. If you want to get up and running on a different OS, you'll need to have the following installed:

• Ruby
• Ruby on Rails
• PostgresSQL
• Yarn

You can use a guide like GoRails, but since we have not tried it ourselves we can't fully endorse it. Let us know how it goes, or if you have tips or experience setting all this up! We're open to including guides for other operating systems.