Different Contributions and their Acknowledgements

Different Contributions and their Acknowledgements#

In the previous subchapters, we discussed how we acknowledge our contributors for their work in The Turing Way. We also describe the Contributors section of the README file and the contributors.md file as Record of Contributions, which are updated regularly to reflect the contribution types and personal highlights of the contributors.

In this subchapter, we will explore the different types of contributions that exist within The Turing Way, and describe those with the help of the personas and pathways our contributors may take to make their contributions. Furthermore, we describe how each persona will be acknowledged in The Turing Way.

Bug fixing#

We use the term “bug” for small errors in the text or code like typos, formatting issues or broken links, or minor fixes.

  • Persona for Small bug fixing: Fraya found a typo and fixed it.

    • Acknowledgement: They are acknowledged in the Contributors table with a 🐛 (bug) emoji.

  • Persona for fixing bug while maintaining sustained engagement: Amal has found multiple typos on multiple visits to the project and contributes to conversations in issues about where these typos cause confusion or need additional input to fix. Amal has had a sustained engagement with the community.

    • Acknowledgement: Amal is acknowledged in the Contributors table with a 🐛 (bug) and an 🤔 (idea) emoji and named as an author on the last 2 releases of the book.

Providing examples#

Contributors can also provide examples that can make The Turing Way chapters comprehensible for readers.

  • Persona for adding examples: Divna made a pull request to add an example that enhanced the quality of the chapter.

    • Acknowledgement: Divna is acknowledged with an 💡 (example) emoji in the Contributors table.

  • Persona for adding examples: Pawel wrote a subchapter and added it through a pull request to add a detailed example that demonstrated the content of the chapter being used in a real world example.

    • Acknowledgement: Pawel is acknowledged with an 💡 (example) emoji in the Contributors table and named as an author on the last 3 releases of the book.

Code and scripts#

We encourage our contributors to write a piece of code, bots or scripts to help improve the project workflow.

  • Persona for writing scripts for the project: Kendra wrote a Python script to spot a Latin word in a new contribution, which should be avoided in this book.

    • Acknowledgement: Kendra is acknowledged with a 💻 (code) emoji in the Contributors table.

  • Persona for reusing an existing tool: Serena set up the continuous integration pipeline for the book using GitHub action features. They further wrote a Python script to make the error report easy to understand and fix.

    • Acknowledgement: Serena is acknowledged with a 💻 (code) emoji in the Contributors table along with the 🚧 (maintenance) emoji and named as an author in the most recent release of the book.

Dataset#

Contributors can provide test data for a test or to link with a chapter to improve the overall content.

  • Persona for reusing a self-generated dataset: Yan created a small dataset to link to the version control chapter to demonstrate how to version control data.

    • Acknowledgement: Yan is acknowledged with a 🔣 (data) emoji in the Contributors table.

  • Persona for creating a data set for the project: Xenia added a data set in the research compendia chapter and wrote a section to explain how to create a compendia for the research data using the example data set.

    • Acknowledgement: Xenia is acknowledged with a 🔣 (data) emoji in the Contributors table along with a 🖋 (content) emoji for writing a chapter. They are named as an author in the most recent version of the book.

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.

  • Persona for reviewing one pull request: Tashan has reviewed a pull request that contributed one additional paragraph to an already existing chapter. They approved the pull request after catching two typos and giving a suggestion for a clearer phrasing of one sentence.

    • Acknowledgement: They are acknowledged in the Contributors table with the 👀 (review) emoji.

  • Persona for reviewing pull request over sustained engagement: Sadaf has reviewed a new chapter on “Secure communication for distributed teams”. She gave comprehensive feedback on the structure of the proposed references and suggested a new format. She was engaged for multiple reviews of the same pull request and engaged closely with the community member who wrote the chapter.

    • Acknowledgement: Sadaf is acknowledged in the Contributors table with the 👀 (review) and 🤔 (idea) emojis, and she is named as an author on the latest release of the book.

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.

  • Persona for writing a chapter: Jordon has written a chapter on “Setting expectations across academia and industry”. He started writing the chapter at a Turing Way Book Dash event, based on an idea they had developed in advance of the event. He responded to review comments and iteratively improved the chapter until the pull request was merged.

    • Acknowledgement: He is acknowledged in the Contributors table with 👀 (review), 🤔 (idea) and 🖋 (content) emojis. He is also named as an author on the latest release of the book.

  • Persona for reviewing and making chapter contribution: Sia recently learned about The Turing Way project and started contributing by reviewing a pull request for the chapter “Setting expectations across academia and industry”. She offered some critical suggestions and engaged in helpful discussions with the author to help them improve their contribution. She ended up writing a new section of that chapter as well.

    • Acknowledgement: She is acknowledged in the Contributors table with 👀 (review), 🤔 (idea) and 🖋 (content) emojis and is named as an author in the latest release of the book.

  • Persona for designing a chapter: At the event, Ishan collaborated with Mafalda in brainstorming a chapter together and created an issue on that. After the event, Ishan did not have time to contribute to the chapter anymore as an author or contributor.

    • Acknowledgement: Ishan is acknowledged in the Contributors table with the 🤔 (idea) emoji.

  • Persona for designing and writing a chapter: After the same event as above, Mafalda completed the chapter that she brainstormed with Ishan. She submitted her contribution as a pull request to The Turing Way and responded to the review comments.

    • Acknowledgement: She is acknowledged in the Contributors table with 🤔 (idea) and 🖋 (content) emojis and is named as an author in the latest release of the book.

Accessibility#

Contributors reporting or working on accessibility issues.

  • Persona for technical improvement for accessibility: Endre wrote a script to make sure that The Turing Way book is properly readable for low vision readers.

    • Acknowledgement: He is acknowledged with an ♿️ (ally) emoji in the Contributors Table along with a 💻 (code) emoji and named as an author in the last 3 releases of the book.

  • Persona for writing accessibility related resources: Rajmund wrote chapters on the community participation in the Community Handbook that discusses the accessibility aspects of working in a research team.

    • Acknowledgement: He is acknowledged with an ♿️ (ally) emoji in the Contributors Table, along with a 🖋 (content) emoji for writing and named as an author in the last 2 releases of the book.

  • Persona for enhancing the accessibility aspects of the resources: Sammy reviewed a few chapters in The Turing Way to remove the gendered language. They also wrote a subchapter in the community handbook’s chapter on a style guide to help others follow a guideline to avoid gendered language from future contributions.

    • Acknowledgement: They are acknowledged with an ♿️ (ally) emoji in the Contributors Table along with a 🖋 (content) emoji for chapter contributions and named as an author in the last 2 releases of the book.

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 Transifex.

  • Persona for translating resources: Anika has translated 3 paragraphs of the version control chapter into Swedish following the standard process defined in The Turing Way repository.

    • Acknowledgement: She is acknowledged in the Contributors table with the 🌍 (translation) emoji.

  • Persona for translating and improving resources: Jamil has translated the version control chapter into Arabic following the standard process defined in The Turing Way repository and adapted the chapter to make it more logical to read in Arabic.

    • Acknowledgement: He is acknowledged in the Contributors table with the 🌍 (translation) and 🖋 (content) emojis, and named as an author on the latest release of the book.

  • Persona for translating resources and mentoring others: Anabel has written a general guideline for translation and translated the introduction chapter into Turkish.

    • Acknowledgement: Anabel is acknowledged with 🌍 (translation), 🤔 and 🖋 (content) emojis, and named as an author on the latest release of the book.

  • Persona for translating resources, mentoring others and maintaining an infrastructure: Anthony has set up the infrastructure and process for managing translation of The Turing Way into multiple languages. They have translated 3 chapters into Chinese and worked closely with the core team to get mentored contributions from other members in multiple languages.

    • Acknowledgement: They are acknowledged with 🌍 (translation), 🤔 (idea), 🚇(infra) and 🚧 (maintenance) emojis, and named as an author on the latest release of the book.

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. These efforts are highly encouraged to ensure the sustainability of their resources that can benefit a much wider community.

  • Persona of a collaborating organisation: The Narnia National AI Institute (NNAII) have agreed to share their internal guidance on communicating safe and ethical artificial intelligence to The Turing Way. The chapters were written by a team of people within NNAII and converted into pull requests that fit The Turing Way style guide. Each individual from the team is listed as a contributor in the Contributors Table with a 🖋 (content) emoji or other relevant contributions they have made.

    • Acknowledgement: The NNAII is acknowledged as a “Collaborating organisation” in the the record of contributions with detailed contributions from each of their members involved in this project.

  • Persona for a contributing member from the organisation: Abby is one of the members of the NNAII who contributed to the guidance before she left to join a non-profit last year. After leaving NNAII, Abby has designed and written a new chapter in her own time.

    • Acknowledgement: In addition to her previous acknowledgments, she will be acknowledged with a 🖋 (content) and 🤔 (idea) emoji in the Contributors Table and her record of contributions will develop independently of the NNAII.

  • Persona for the supporting (indirect contributor) members from the organisation: Kadie is a programme director at the NNAII who manages the team that wrote the guidance that has been incorporated into The Turing Way.

    • Acknowledgement: She is acknowledged in the Contributors table with the 💵 (finance) emoji. Kadie was asked if she would like to be an author on the most recent release of The Turing Way book but declined as she did not personally feel that she had contributed enough to be named as an author.

  • Persona for a contributing member from the organisation with sustained engagement: Patty works in a National Library and her employers have approved her to host their resources as chapters in The Turing Way. Patty has developed materials, contributed to the community discussions and reviewed others’ pull requests on the GitHub repository.

    • Acknowledgement: Patty will be listed in the Contributors Table with 🤔 (idea), 🖋 (content) and 👀 (review) emojis and named as an author on the latest release of the book..

Maintenance#

Maintenance work in The Turing Way applies to multiple aspects, some of which are: responding to the questions in community spaces such as Gitter, GitHub issues, or X (formerly Twitter); the technical infrastructure of the GitHub repository, associated GitHub bots, scripts and continuous integration pipeline; the online hosting platforms of Jupyter book and Netlify; and the translation infrastructure of Transifex.

  • Persona for maintaining community interactions: Neve has helped two contributors on two individual occasions by responding to a question on the Turing Way Gitter channel and a question on one of the issues in The Turing Way GitHub repository.

    • Acknowledgement: He is acknowledged in the Contributors table with the 💬 (question) and 🤔 (idea) emojis.

  • Persona for maintaining community interactions with sustained engagement: Ursula regularly points new contributors to documentation and submits pull requests to improve the guidance when she sees unclear areas. She reviews pull requests from others working to make the process of contributing smoother.

    • Acknowledgement: She is acknowledged in the Contributors table with the 💬 (question), 🤔 (idea), 👀 (review) and 🚧 (maintenance) emojis, and named as an author on the last two releases of the book.

  • Persona for maintaining project infrastructure: Gaia is maintaining the back-end infrastructure of the Jupyter Book and supports the continuous integration aspect of the project repository by replying to related issues and providing solutions to fix them.

    • Acknowledgement: She is acknowledged in the Contributors table with 🚇 (infra) and 🚧 (maintenance) emojis, and named as an author on the latest release of the book.

  • Persona for maintaining project infrastructure and mentoring others: Jamil has set up the infrastructure and process for managing translation of The Turing Way into multiple languages. They support new translators by answering their questions related to the translation process.

    • Acknowledgement: They are acknowledged with 🤔 (idea), 🚇 (infra) and 🚧 (maintenance) emojis, and named as an author on the latest release of the book.

Representing the Turing Way#

Anyone who shares The Turing Way resources in any relevant publication, learning material, conference presentations or community event is acknowledged for representing The Turing Way. These members may or may not have previously contributed to the project. They either volunteer or are recommended by The Turing Way team members for representing this community within or outside the project.

  • Persona for highlighting project resources: Yehuda used one of the Scriberia and The Turing Way illustrations in a recent talk they gave at an open source workshop that was hosted by their company. They included links to The Turing Way book, GitHub repository and X handle. Their slides are available under a CC-BY license and are requested to be linked in a monthly newsletter.

    • Acknowledgement: They are acknowledged in the Contributors table with the 🔊 (Talk) emoji.

  • Persona for giving a talk on The Turing Way: Noah is a long time contributor to The Turing Way, they answer questions and review pull requests regularly. In March 2020, Kirstie - lead developer of The Turing Way - recommended Noah as a suggested speaker to give a talk about the Project Design section of The Turing Way at a conference on open source community management. She worked with Noah to practice his presentation in advance of the talk. Noah’s slides are available under a CC-BY license and are linked from a page in the community handbook.

    • Acknowledgement: They are acknowledged in the Contributors table with the 🔊 (Talk), 🚧 (maintenance), 👀 (review), 🤔 (idea) and 💬 (question) emojis and named as an author on the last release of the book.

Training, workshops or community events#

Members can help in organising a training session, host a workshop delivered by the team members, or help in delivering a community event.

  1. Klara delivered a training session on Binder co-organized by The Turing Way core team members.

  2. Petra helped organising a 2-hour long workshop by The Turing Way at a PhD conference and helped deliver it by managing contributions on the GitHub repository.

  3. Uri previously attended a book dash event as a selected participant and joined the most recent book dash as a helper to support new attendees.

  4. Paolo hosted a Collaboration Cafe in a time zone compatible with the contributors from New Zealand.

Acknowledgement: All these contributors will be acknowledged with the 📋 (eventOrganizing) emoji in the Contributors Table.

Tutorial and training material#

We invite our members to create tutorials or share their training materials that can be supplemented with the existing chapters in The Turing Way.

  • Persona for creating training materials in the project: Aune added multiple-choice questions (as a tool for formative assessment) at the end of 3 different chapters to help readers evaluate their understanding of the concepts described in those chapters.

    • Acknowledgement: She is acknowledged with the ✅ (tutorial) emoji in the Contributors table.

  • Persona for reusing a training material in the project: Leo had developed training material on machine learning for a workshop they organised in the past for their colleagues. They have added this material with a new chapter they authored in the book for reproducibility in The Turing Way.

    • Acknowledgement: They are acknowledged with the ✅ (tutorial) emoji in the Contributors table along with the 🖋 (content) emoji and named as an author on the latest release of the book.

Blog posts and articles#

Contributors writing about The Turing Way in articles, blogs, or other online publication platforms.

  1. Khasan wrote a relevant online blogpost that was highlighted in the monthly newsletter.

  2. Eva wrote a research article and cited a chapter from The Turing Way, which was then added to the The Turing Way bibliography.

Acknowledgement: These contributors are acknowledged with the 📝 (blog) emoji in the Contributors Table.

Videos and recordings#

We encourage creating video content or animations, recording online interactive discussions or linking any relevant videos our contributors may have created in the past that can be used as a learning tool and enhance the quality of The Turing Way content.

  • Persona for helping record and edit videos for the project: Jakaria hosted a collaboration cafe, recorded the session, edited to be uploaded on The Turing Way YouTube channel.

    • Acknowledgement: Jakaria is acknowledged with the 📹 (video) emoji in the Contributors table along with the 📋 (eventOrganizing) emoji for event organisation.

  • Persona for creating training videos: Rene created 3 short videos to guide step by step learning of git-based version control and linked them to an existing chapter on git and GitHub.

    • Acknowledgement: Rene is acknowledged with the 📹 (video) emoji in the Contributors table and named as an author on the latest release of the book.

Financial support#

Researchers and support staff from a collaborating organisation can help with searching for funding, help with writing a grant proposal or providing financial support directly or indirectly for the development of the project.

  • Persona for managing funding: Laura is managing the sponsorship offered to The Turing Way through one of its collaborating organisation.

    • Acknowledgement: Laura is acknowledged with the 💵 (financial) emoji in the Contributors table.

  • Persona for helping gain funding: Ismael shared a funding opportunity with an intention to financially support the development of the guide on ethical research. They also helped in editing a grant proposal.

    • Acknowledgement: Ismael is acknowledged with the 🔍 (fundingFinding) emoji in the Contributors table and the 💵 (financial) emoji for their support and work and named as an author on the latest release of the book.

Project Management#

Team members, core contributors and community members with sustained engagements often take on project management tasks and support The Turing Way community and project as a whole.

Acknowledgement: These members are acknowledged with the 📆 (projectManagement) emoji in the Contributors table.

Did we miss listing a contribution type? Please create an issue on the GitHub repository to discuss that with the team members.