Record of Contributions#

Two documents in our GitHub repository are used for creating a record of contributions in The Turing Way: Contributors Table in the README file, and contributors.md file. This record is made available in the afterword of this book as Contributors and Personal Highlights. These documents can be used for highlighting skills that our members have gained and shared through their involvement in The Turing Way.

We invite all our members to co-create this record to capture the important work they do around answering questions, representing the project, developing and maintaining the infrastructure, and all other nurturing roles that make The Turing Way community so special.

The process of developing this record is described below in detail.

1. Contributors Table#

The Contributors table in README file is updated with every contributor’s name using the all contributors bot’s emoji key.

No contribution is too small, and these emojis allow us to recognise and fairly acknowledging all kinds of contributions our community members make to the project. Those contributions can include (but are not limited to) bug fixing, chapter planning, writing, editing, reviewing, idea generation, presentation, project management, and maintenance. Please see the subchapter Acknowledgement Examples for details.

Table with different emojis that is used by the contributors bot

Fig. 134 Emoji key table of the all contributors bot that The Turing Way uses for acknowledging different contributions from the community members.#

2. Contributors file#

The contributors file, called contributors.md in the GitHub repository, will hold specific details provided by community members regarding their involvements in the project. This will be referred to as contributor's detail in the rest of this document:

Contributor's name

  • Role: This is an optional entry for any specific role contributors have assumed in the project. It is also a place to mention the date/year since a contributor has taken this role. Examples, "Core contributor (2018-present)", Translation lead (2020), or Code of Conduct committee member (2019-2020).

  • GitHub id: GitHub id, example: [@kirstiejane](http://github.com/kirstiejane)

  • ORCID: ORCID id of the contributor, example: [0000-0001-8498-4059](https://orcid.org/0000-0001-8498-4059)

  • Short Bio: 1-2 sentences about themselves

Then, our contributors will add “Personal highlights”, which will hold details of their contributions to The Turing way:

  • Personal highlights: GitHub contributions, PRs and issues. Further details have been discussed below.

Additionally, contributors can opt to add more information they think can help them share their work and engagement with The Turing Way project by supplementing “More information”:

  • More information: Additional information provided by the contributors. This is optional.

Personal highlights#

Specifications for all types of contributions made towards The Turing Way can be added in the contributors file as personal highlights.

These highlights can be individually decided by the contributors to record what they consider to be their significant and useful for their personal profile. This can be supplemented with supporting materials such links to chapters, pull request, issues, and blog posts.

This record can be directly translated towards the professional development of our community members, which can be further used for enhancing their personal or professional portfolio (profile, CV, resume) (see the contributors.md file).

The Turing Way was originally funded by a Strategic Priority Fund investment to the Alan Turing Institute to support AI For Science and Government. The personal highlights are very valuable for capturing the impact that The Turing Way has for its community members in terms of personal networking, professional development, skill sharing and other relevant activities, and how they have made positive impacts around transparency, reproducibility and ethical collaboration in their organisation.

Recording different types of contributions#

In the contribution types discussed below, we use scenarios from some of the most common contribution types.

These examples are also outlined in the next subchapter Acknowledgement Examples along with other types of contributions that are made to The Turing Way.

We recommend using these example statements only as a guide. As a contributor, you will be able to add as many details as useful for your record.

Bug fixes#

A “bug” is a small error in the text or code like typo, formatting issue or broken links.

Anyone who raises bugs, related issues or fixes them are listed as contributors in the Contributors table with 🐛 (bug) emoji.

The contributor’s file will be updated for the contributors with a similar statement as below after the contributor's detail:

  • Personal highlights:

I have fixed typos and made other contributions other details like identified sections of the book that are unclear.

Reviewing chapters and other pull requests#

The review process of a newly contributed chapter or a subsection of an existing chapter involves approving the language and structure of a chapter or a section of a chapter, flagging errors or typos, asking for clarifications if certain parts of the content or statements are unclear, suggesting modifications and improving the overall quality of someone’s contribution.

Anyone who reviews a chapter is listed as reviewers and are acknowledged with 👀 (review) emoji in the Contributors table.

The contributor’s file will be updated for the contributors with a similar statement as below:

  • Personal highlights:

I have reviewed the chapter Chapter name. I made other contributions to the chapter other details like structuring and adding references.

Chapter contribution#

The various contributions to a chapter are made towards designing, writing, and reviewing its content through GitHub issues, pull requests, and reviewing processes.

The designing, writing, and reviewing of a chapter’s content are acknowledged with 🤔 (idea), 🖋 (content) and 👀 (review) emojis respectively in the Contributors table.

The contributor’s file will be updated for the contributors with a similar statement as below:

  • Personal highlights:

I have designed and written a chapter on chapter name and details on reviewing and structuring new content.

Translation#

The translation process in The Turing Way includes aspects translating The Turing Way chapters into languages other than English and reviewing them. The translation infrastructure as of May 2020 is Trasifex.

Contributors who participate in the translation process will be acknowledged in the Contributors table with the 🌍 (translation) emoji.

The contributor’s file will be updated for the contributors with a similar statement as below:

  • Personal highlights:

I have translated part of the chapter chapter name into language. I have also details like designed and implemented a process to translate the book into multiple languages, mentored multiple contributors within the community and has translated 3 chapters of The Turing Way into Chinese.

Organisational support#

When members participate in The Turing Way community with the in-kind support of their funders and organisation, we acknowledge each member individually and list their organisations as “Collaborating organisations”. Such organisational supports are applicable when one or multiple members from a project or community collaborate to build resources in The Turing Way.

Each organisation who supports its members to collaborate with The Turing Way will be listed as “Collaborating organisations” in the contributor’s file. Each contributor from these organisation will be acknowledged individually in the Contributors Table for their specific contributions with emoji keys reflecting specific contributions made with the organisational support. Their contributors will be listed under their organisation’s name in the contributor’s file.

Every contribution from collaborating organisation will be updated with a similar statement as below:

  • Personal highlights:

I have made contributions contribution type to the chapters chapter name. I have also details on other contributions like managing a team of contributors, writing a chapter.

Maintenance#

Maintenance work in The Turing Way applies to the conversations in community spaces, technical infrastructure, online hosting platforms for the book, and translation infrastructure of Transifex.

Contributors will be acknowledged in the Contributors table with the 💬 (question) emoji for answering questions, 🤔 (ideas) emoji for discussions, 🚇 (infra) emoji for infrastructure support, and 🚧 (maintenance) for community efforts or infrastructure maintenance.

The contributor’s file will be updated for the contributors with a similar statement as below:

  • Personal highlights:

I have details like responded to questions in the community's Gitter channel, mentored multiple contributors within the community and has reviewed pull requests to fix typos in the book, maintains the backend infrastructure of the project, provide support and solution regarding Jupyter book and continuous integration, designed and implemented a process to translate the book into multiple languages, helped multiple contributors in facilitating translation efforts.

Representing the Turing Way#

Anyone who shares The Turing Way resources in any relevant publication, learning material, conference presentations, or community event are acknowledged for representing The Turing Way.

Each contributor who represents The Turing Way at an event is acknowledged in the Contributors table with the 📢 (Talk) emoji in the Contributors Table along with other contributions as applicable.

Their contributions will be listed in the contributor’s file with a similar statement as below:

  • Personal highlights:

I have presented a talk at The Turing Way at event's name. I have also details like mentored multiple contributors within the community and have given talks at and event on behalf of the community.

Please read personas and pathways for different contributions in the next subchapter.