Skip to content
This repository has been archived by the owner on May 21, 2024. It is now read-only.

Latest commit

 

History

History
83 lines (57 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

83 lines (57 loc) · 3.56 KB

Contributing Guide

Thank you for investing your time in contributing to this project. It's exciting that so many people are interested in keeping Gitpod self-hosted alive and vibrant.

Issues

There is an inherent blurring of lines in this project when it comes to issues. Namely, what is an issue on Gitpod and what is an issue on Self-Hosted?

Please don't submit feature requests or bugs for the Gitpod project itself. Although I am a former Gitpodder, as of January 2023 I am no longer part of the team. Self-hosted used to be an important part of the Gitpod business model, but was abandoned in December 2022 - the scope of this project is to maintain Gitpod as a self-hosted solution, not maintaining a fork of Gitpod itself.

Any Gitpod-related issues should be raised on their GitHub account.

Create a new issue

If you spot an issue with your Gitpod installation, search if an issue already exists. If no issue exists, you can open a new issue via the form.

Solve an issue

Look through the existing issues to find one that interests you. As a general rule, issues won't be assigned to anyone. Once you're happy with your change, please open a pull request with a fix.

Making Changes

It is recommended that all changes are done in Gitpod (if you don't use it, why are you here?) as that is the most up-to-date working environment. A Devbox file is also maintained.

Commit Your Update

Commit the changes once you are happy with them. Please enusre that all commit messages use the Conventional Commits format. This makes all messages consistent and will allow for automated release management in the future (if necessary).

See the documentation for examples.

Pull Request

When you're finished with the changes, create a pull request (PR).

As a general rule, it's a good idea to create a draft PR early. This will run the changes through the CI/CD pipeline (GitHub Actions). It will also flag up any conflicts so you can fix them early.

Please ensure that an issue exists prior to creating a pull request. This ensures that the work is desirable to the project and avoids lots of unnecessary work. Exceptions are made for small, typo-style fixes.

Cloud credentials

This project is run by an individual (not Gitpod) and I cannot justify the expense in signing up to test multiple cloud providers.

If you're submitting a setup for a new cloud provider, you will need to also submit credentials for a paid-account for the cloud provider in question (please don't add your raw keys to the PR).

You can encrypt your keys with my public GPG key or contact me to discuss things further.