Skip to content

Latest commit

 

History

History
80 lines (65 loc) · 3.95 KB

README.md

File metadata and controls

80 lines (65 loc) · 3.95 KB

deliveroo.engineering

The deliveroo.engineering blog is the Deliveroo Engineering team’s presence on the web. It is hosted using Github Pages, which runs on Jekyll. The main bits of the blog are built using Liquid and SCSS. Content written for the site is formatted with Markdown.

Running deliveroo.engineering locally

If you’re doing any work on any part of the deliveroo.engineering blog, the best way to test it is to run it locally:

  1. Install docker
  2. $ git clone [email protected]:deliveroo/deliveroo.engineering.git
  3. $ cd deliveroo.engineering
  4. $ make build
  5. $ make run
  6. Open http://localhost:4000 in your browser

Jekyll will then generate the site files automatically for you, which usually takes no more than a couple of seconds each time you make a change.

Submitting a blog post

We love it when our engineers are able to share the lessons of their experiences with the world (and each other!). If you have anything you’d like to write about which has relevance to the world of engineering, create a pull request!

  1. Name your branch blog-posts/name-of-your-post.
  2. Read the meta-guidelines on how to format your post with Markdown.
  3. Look at the example blog post to get an idea on how to structure your post.
  4. If you’ve not written a blog post before, create an author bio page using the example bio as a template, and add a square photo of yourself to the portraits folder. Ideally this should be a JPEG of at least 600px square.
  5. Test your blog post locally to ensure it looks okay.
  6. Create a pull request and tag it with ready for editor review.
  7. Invite feedback from the Engineering team!

Submitting an engineering guideline

As well as a place to share our experiences and insights, the engineering blog is also a repository of our accumulated best practices for development across all the different technologies we work with. There are numerous guidelines documents corresponding to these technologies; you can contribute to these with your own insights, linting or formatting rules, or create an entirely new guideline for anything we don’t yet document or have standards for.

  1. Name your branch guidelines/whatever-it-relates-to.
  2. Read the meta-guidelines on how to format your guidelines with Markdown.
  3. Look at the example guidelines to get an idea on how to structure your guidelines document.
  4. Test your guidelines documentation locally to ensure it looks okay.
  5. Create a pull request and tag it with guideline for review.
  6. Invite feedback from the Engineering team!

Submitting improvements to the blog website

If you’re submitting a general improvement or bugfix to the blog website itself, follow standard process by opening a pull request, and tagging the issue appropriately with bugfix, design, refactor etc.