-
Notifications
You must be signed in to change notification settings - Fork 1
Contributing
Welcome to the Ghost repository!
This document is intended as a one-stop shop for getting started with contributing to the codebase. Please feel free to add anything you find to be missing.
You first port of call should probably be the working on ghost core guide in the CONTRIBUTING.md which details all the dependencies you need to build Ghost from the repo.
All code should conform, strictly, to the Ghost project Code Standards.
All HTML and CSS should conform to the Code Guide, maintained by Mark Otto.
All code must also pass our unit and functional tests. You can check this by running grunt validate. We use Travis CI to run both a linter and our unit tests against all Pull Requests.
Work is very much underway towards achieving version 0.3. You can find out the plan by reading the Version 0.3 Roadmap and also take a look at the issue list. If you see any issue you are interested in working on, let Hannah know by leaving a comment or dropping her a message in IRC/Skype.
If you have ideas for something you'd like to implement or improve which isn't on the roadmap, feel free to open issues and PRs for these. Opening a PR or Gist for a refactor or idea for something is often the best way to get a discussion started.
Please read the Git workflow documentation with regards to writing commit messages, opening Pull Requests, branching strategies and other general git process related stuff.
When submitting Pull Requests or Issues, often screenshots or .gifs of the problem or new functionality can be beneficial. We recommend LICEcap as a tool to record .gifs of your screen (set your 'FPS' to '24' to get smooth results).