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.

Joining the community

Before you begin contributing to MapReader, we would love for you to join our community and there are many ways to do this:

You can also get in touch with the MapReader team personally by:

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.

How to add yourself as a contributor

We use the all-contributors bot to keep a record of contributors to the MapReader repo. To add yourself as a contributor to MapReader, comment on your issue or PR with the following:

@all-contributors please add @your_username_here for A, B, C

Note

Remember to change this to your GitHub username!

for example, to add Katie McDonough for research, ideas and docs, you would write:

@all-contributors please add @kmcdono2 for research, ideas, docs

Types of contribution

Emoji/Type

Represents

Comments

💻 code

Code

🔣 data

Data

📖 doc

Documentation

e.g. ReadtheDocs, Wiki, or other source of documentation

🤔 ideas

Ideas & Planning

🚧 maintenance

Maintenance

People who are actively maintaining the repo

🧑‍🏫 mentoring

Mentoring

People who mentor new contributors

📆 projectManagement

Project Management

🔬 research

Research

👀 review

Reviewed Pull Requests

🌍 translation

Translation

✅ tutorial

Tutorials

e.g. worked_examples or external tutorials.

📢 talk

Talks

Guides