Contribution Guide

We're happy to have you contributing to our codebase! We recommend you go through the following guide.

Technical Requirements

You'll need to have some basic programming experience with the technologies and tools we use.

Tools

Languages & Frameworks

Project Structure

The project's core repositories are divided into three:

Project Setup

This section explains how you can get Open Collective running locally on your computer.

Frontend

Setting up the frontend is straightforward. We've provided a comprehensive guide in a separate document that explains how to set up the project.

Setup guide

https://github.com/opencollective/opencollective-frontend/blob/main/README.md

NOTE: If you're only contributing frontend code, you don't need to setup the API.

API

The API setup requires more effort than the frontend, as it requires installing the PostgreSQL. You might experience difficulty setting up the API on a Windows environment. We recommend using a Unix environment.

Just like the front end, we have a separate document for the setup.

Setup guide

https://github.com/opencollective/opencollective-api/blob/main/README.md

Others

Design Contribution

Like to contribute to our design? Checkout our design contribution guidelines.

Commit conventions

Before you make your first commit, read through our commit convention, provided in the link below:

https://github.com/opencollective/opencollective-frontend/blob/main/CONTRIBUTING.md

Bounty Program

We recommend you learn more about our bounty program through the link below:

https://docs.opencollective.com/help/developers/bounties

Ask for Help

If you are stuck or have a question, join our Discord #engineering channel through the link below:

discord.opencollective.com

We're trying our best to make our documentation better. We encourage you to give suggestions on how we can improve it.

Last updated

Ⓒ Open Collective 2024