The Record of Contributors in the Afterword is where contributors to The Turing Way are presented. The Record of Contributors draws from three sources,
Table 1:The current sources for contributor information and how they are presented in the book.
| Record type | Source | Presented in |
|---|---|---|
| Individual highlights and profiles | Page source | Individual Contributors |
| All contributors | All contributors file | All Contributors |
| Translations | Crowdin API | Translators |
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.
Getting Recognised¶
All Contributors Table¶
The all contributors table is updated with every contributor’s name using the all contributors bot’s emoji key.
Instructions for using the all contributors bot are given in the contributing guide.
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 Different Contributions and their Acknowledgements for details.
Figure 1:Emoji key table of the all contributors bot that The Turing Way uses for acknowledging different contributions from community members.
Individual highlights and profiles¶
To add or edit your profile on the Individual Contributors page, edit that page.
We use the profile directive to create entries.
Instructions for how to use the directive are given here.
All types of contributions made towards The Turing Way can be added to personal highlights. These highlights can be individually decided by the contributors to record what they consider to be their significant and useful contributions for their personal profile. This can be supplemented with supporting materials such as links to chapters, pull requests, 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).
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.
Translators¶
The data for the record of translators is fetched from the Crowdin API. A regular action is run to open a pull request updating this data. If you have contributed translations to The Turing Way through Crowdin, you should automatically be acknowledged.