Contributing

Contributing Words

Editing Existing Pages

It’s easy to edit an existing article using GitHub. At the bottom of every article is a contribute link. It’ll take you to the corresponding page on GitHub. From there, click the edit button, log in to GitHub (create an account if you need to) and edit away.

Articles are written in Markdown, a simple language that makes writing for the web easier. Learning Markdown is super easy, it’ll take you no longer than 5 minutes. You can find a basic tutorial here.

When you submit an edit you’re creating what’s called a pull request. I’ll see this, check it looks OK and approve it (assuming it is OK). If it takes a while for your edit to appear, it’s because I haven’t had time to check it out yet.

Creating New Articles

Before you create an article, please check that what you’re writing is relevant. This website is aimed at people studying the UK AQA Geography AS course. Read the course specification [PDF] before writing anything so you know you’re writing something relevant.

When you’ve written an article, submit it via an email with the subject “ARTICLE: …”. Submissions should be written in Markdown but if you must use Word then I’ll convert it to Markdown for you. If you include images in the article, attach them to the email and reference them by name in the article. I’ll change the references to point to the images. You must ensure that you have permission to use an image in an article. If the image requires attribution, include it in the article.

Article Submission Link

Alternatively, you can submit an article by forking the site’s github repository.

Creating a New Topic

If you want to undertake writing an entire topic then email me so we can work together. I’ll act as an editor and ensure that your articles are reviewed ASAP.

Style Guide

This site’s articles don’t follow any established style guide but there are a few guidelines that should be followed:

Contributing Pictures

Photographs

If you have a photograph that will complement an article, email it to me with the subject “PHOTO: …”. There’s no need to compress it, I’ll handle that. In your email, tell me the license you’re releasing the image under and how you want to be attributed (e.g., a link to your website).

Photo submission link

Diagrams

Diagrams are appreciated as my drawing ability is limited. If you want to submit a diagram, send me an email with the subject “DIAGRAM: …”.

Diagram submission link

Although we need diagrams, there are some stringent rules for submissions. First, submissions must include both an SVG and PNG version of your diagram. This ensures that users of high DPI devices get good quality diagrams. Inkscape is an excellent and free vector graphics editor than can produce SVG and PNG files. There’s also Inkpad for the iPad which has a gentler learning curve.

Besides the file requirements, there’s also a style guide for diagrams. It’s really important you follow this guide because it makes reading diagrams faster for regular readers and ensures diagrams don’t look out of place on the website.

Diagram Style Guide

A few additional styles for graphs:

Diagram Colour Scheme

A consistent colour scheme across diagrams ensures that common features are identifiable without a key. Like the style guide, it’s very important that you follow this colour scheme.

Earth/Terrain

Hex: #855723

RGB: R:133 G:87 B:35

Hard Rock

Hex: #493829

RGB: R:73 G:56 B:41

Grass

Hex: #668D3C

RGB: R:102 G:141 B:60

Deep Water

Hex: #092B5A

RBG: R:9 G:43 B:90

Shallow Water

Hex: #09738A

RGB: R:9 G:115 B:138

Sand/Sediment/Soft Rock

Hex: #C8A87A

RGB: R:200 G:168 B:122

Code

The entire website is available on GitHub. Its main purpose is for other people to learn from it but if you want to contribute any code, feel free. The website’s built using Jekyll, Sass and CoffeeScript. There’s also a little bit of jQuery mixed in there.


  1. This example is adapted from a slightly more risqué example which I won’t link to.

  2. I haven’t done a good job sticking to this rule because I love using ampersands. They feel classy.