Contribution Guide

Welcome! We are pleased to know that you’re interested in contributing to MapReader!

MapReader is a collaborative project, now expanding its community beyond the initial group in the Living with Machines project (The Alan Turing Institute). We welcome all contributions but please follow these guidelines to make sure your contributions can be easily integrated into the project.

Pre-requisites

Regardless of how you will be contributing to MapReader, you will need to:

  1. Ensure you have a GitHub account set up.

  2. Be able to use GitHub issues and pull requests - if you are unfamiliar with these, please look at our GitHub guide before continuing.

  3. Set up a virtual Python environment and install MapReader (as per our Installation instructions).

  4. Have read this guide.

Ways to contribute

We welcome contributions from community members of all skill levels and so have written three different guides for different types of contributions:

  • Write a tutorial or worked example - For those who are familiar with using MapReader and would like to showcase an example of how to use it, but are not comfortable with using Sphinx to write documentation or writing code.

  • Add to or update the MapReader documentation - For those who are familiar with using MapReader and either already comfortable with using Sphinx to write documentation or feel able to have a go at to learning it.

  • Add to or update the MapReader code - For those who are familiar with using MapReader and either already comfortable with writing code in Python or feel able to have a go at learning it.