Introduction

Contributing guide

So you're interested in giving us a hand? That's awesome! We've put together some guidelines that should help you get started quickly and easily. If you need help with anything, please come visit our slack community. Thank you for stopping by!

Quick Links:

Guideline Contents

Raising Issues

If you're looking to raise an issue because think you've found a problem with Ghost, or you'd like to make a request for a new feature in the codebase, or any other reason… please read this first.

The GitHub issue tracker is the preferred channel for bug reports, change requests and submitting pull requests, but please respect the following restrictions:

  • Please search for existing issues. Help us keep duplicate issues to a minimum by checking to see if someone has already reported your problem or requested your idea.

  • Please do not use the issue tracker for personal support requests (use slack or stackoverflow if you prefer).

  • Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.

Bug Reports

A bug is a demonstrable problem that is caused by the code in the repository.
Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the latest master or look for closed issues in the current milestone.

  3. Isolate the problem — ideally create a reduced test case and a live example.

  4. Include a screencast if relevant - Is your issue about a design or front end feature or bug? The most helpful thing in the world is if we can see what you're talking about. Use LICEcap to quickly and easily record a short screencast (24fps) and save it as an animated gif! Embed it directly into your GitHub issue. Kapow.

  5. Include as much info as possible! Use the Bug Report template below or click this link to start creating a bug report with the template automatically.


A good bug report shouldn't leave others needing to chase you up for more information. Be sure to include the details of your environment.

Here is a real example of a great bug report.

Template Example (click to use):

Short and descriptive example bug report title

### Issue Summary

A summary of the issue and the browser/OS environment in which it occurs.

### Steps to Reproduce

1. This is the first step
2. This is the second step, etc.

Any other info e.g. Why do you consider this to be a bug? What did you expect to happen instead?

### Technical details:

* Ghost Version: master (latest commit: a761de2079dca4df49567b1bddac492f25033985)
* Node Version: 4.4.7
* Browser: Chrome 48.0.2564.109 on Mac OS X 10.10.4
* Database: SQLite / MySQL

Feature Requests

If you've got a great idea, we want to hear about it. Our user wishlist exists so that we can learn more about what our community wants us to build.

Please use your discretion to decide whether a feature request belongs on the wishlist or whether it's better suited to a GitHub issue.

Before making a suggestion, here are a few handy tips on what to consider:

  1. Visit the Roadmap, wishlist & search to see if the feature has already been requested

  2. Check out What makes it into Ghost core? - this explains the guidelines for what fits into the scope and aims of the project

  3. Have a quick think about whether your feature is for the admin UI, the blog output, themes or apps - or does it affect multiple areas? This can help when describing your idea.

  4. Remember, it's up to you to make a strong case to convince the project's leaders of the merits of a new feature. Please provide as much detail and context as possible, this means explaining the use case and why it is likely to be common. The strongest vote in favour of any feature request is hands-down, un-debatable traction on our user wishlist.

Change Requests

Change requests cover both architectural and functional changes to how Ghost works. If you have an idea for a new or different dependency, a refactor, or an improvement to a feature, etc - please be sure to:

  1. Use the GitHub search and check someone else didn't get there first

  2. Take a moment to think about the best way to make a case for, and explain what you're thinking as it's up to you to convince the project's leaders the change is worthwhile. Some questions to consider are:

    • Is it really one idea or is it many?
    • What problem are you solving?
    • Why is what you are suggesting better than what's already there?


Working on Ghost core

If you want to modify Ghost or Ghost-Admin files it's recommended that you get a development environment set up. We have a guides for Ghost and Ghost-Admin:

Submitting pull requests

Pull requests are awesome. If you're looking to raise a PR for something which doesn't have an open issue, please think carefully about raising an issue which your PR can close, especially if you're fixing a bug. This makes it more likely that there will be enough information available for your PR to be properly tested and merged. To make sure your PR is accepted as quickly as possible, please take a minute to check the guidelines on:

Need Help?

If you're not completely clear on how to submit / update / do Pull Requests, please check out our in depth Git Workflow guide for Ghost, or visit slack and we'll help you out.

Checking out a Pull Request

The dev blog has detailed instructions on configuring your environment to allow you to checkout pull requests with this simple command: pr #1234

Looking for something to work on?

If you're interested in contributing to Ghost and don't know where to start, here's a few tips:

  • The beginner label indicates issues which should be suitable for someone new to the Ghost codebase
  • The help wanted label highlights issues that need a champion

If you're still stuck, please come join us in slack and let us know what you're interested in!

What makes it into Ghost core?

If you're trying to determine whether or not a feature you're interested in will be implemented in Ghost core, there are 4 key principles:

  • Is it fundamentally core to publishing digital content? Would it likely be useful to the majority of our user base? If yes, then it will probably be in Ghost core. E.g I18n, post scheduling, etc.
  • Is it so large and complex that other companies have entire teams and infrastructures dedicated to it? Then it will probably be provided through 3rd party integrations. E.g. Comments, and media management.
  • Is it only relevant to a small group, or for a short time / one off use? If yes, it is probably app territory. E.g. XML-RPC, Import tools
  • Is it only possible to achieve by adding to or modifying core? If yes, then it will be considered in terms of benefit vs complexity.

These are the guiding principles, they are somewhat subjective but they provide a framework for anyone to use to interpret whether or not a feature might be considered for Ghost core. There will always be exceptions.

When making a feature request, keep in mind that Ghost is a publishing platform for the masses. It's aim is to be the go-to solution for publishing content to the web - we want to do one thing, REALLY well. The aim of the Ghost architecture is to provide for the most common use cases in Ghost core and provide for extensibility so that less common use cases can be catered for with apps and extensions.


Testing and Quality Assurance

Never underestimate just how useful quality assurance is. If you're looking to get involved with the code base and don't know where to start, checking out and testing a pull request is one of the most useful things you could do.

Essentially though, check out the latest master, take it for a spin, and if you find anything odd, please follow the bug report guidelines and let us know!

Documentation

Ghost's user documentation can be found at help.ghost.org, if you have feedback or would like to write some user documentation, please let us know by emailing support.

Ghost's developer documentation can be found at docs.ghost.org. These docs are written and hosted on readme.io which has a suggested edits feature through which you can submit updates. If you'd like to get more involved than just making amendments, email support and let us know :)

The Public Roadmap

We have a public trello board which acts as a general roadmap and to make it easier for everyone to keep track of ongoing work. If you would like to receive regular updates on our progress, you can subscribe to the Dev Blog which is updated with every public release and major announcement.

For information on how the new roadmap works, see trello.

Contributor License Agreement

By contributing your code to Ghost you grant the Ghost Foundation a non-exclusive, irrevocable, worldwide, royalty-free, sublicenseable, transferable license under all of Your relevant intellectual property rights (including copyright, patent, and any other rights), to use, copy, prepare derivative works of, distribute and publicly perform and display the Contributions on any licensing terms, including without limitation:
(a) open source licenses like the MIT license; and (b) binary, proprietary, or commercial licenses. Except for the licenses granted herein, You reserve all right, title, and interest in and to the Contribution.

You confirm that you are able to grant us these rights. You represent that You are legally entitled to grant the above license. If Your employer has rights to intellectual property that You create, You represent that You have received permission to make the Contributions on behalf of that employer, or that Your employer has waived such rights for the Contributions.

You represent that the Contributions are Your original works of authorship, and to Your knowledge, no other person claims, or has the right to claim, any right in any invention or patent related to the Contributions. You also represent that You are not legally obligated, whether by entering into an agreement or otherwise, in any way that conflicts with the terms of this license.

The Ghost Foundation acknowledges that, except as explicitly described in this Agreement, any Contribution which you provide is on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

Introduction

Contributing guide