Skip to content

Latest commit

History

History
25 lines (14 loc) 路 1.56 KB

CONTRIBUTING.md

File metadata and controls

25 lines (14 loc) 路 1.56 KB

Contributing to Ghost

Welcome! Thank you in advance for your interest in contributing to Ghost!

The Basics

Ghost welcomes contributions in the form of pull requests.

For small changes (e.g., bug fixes), feel free to submit a PR.

For larger changes (e.g., new functionality, new configuration options), consider creating an issue outlining your proposed change.

Prerequisites

Ghost is written in Go. You'll need to install the Go toolchain for development.

Development

The easiest way to get set up with everything you need is to work in a Dev Container or in GitHub Codespaces. The Ghost repo includes a Dev Container configuration. By opening the repo in a Dev Container, you will have all tools/dependencies installed for you for easy contributing.

If you already have Visual Studio Code and Docker installed, you can install the Dev Containers extension and then use the Dev Containers: Clone Repository in Container Volume... command to open your fork. If you are using GitHub Codespaces, the environment will be automatically set up for you as the container is built.

If you'd like to use another editor/IDE, just create a fork + clone the repo!

Adding yourself to the contributors listed in the Ghost README

If you'd like to be included in the list of contributors, you can follow these instructions to do so!