# _The Turing Way_

>_This README.md file is also available in Chinese ([README-Chinese](README-translated/README-Chinese.md)), Dutch ([README-Dutch](README-translated/README-Dutch.md)), French ([README-French.md](README-translated/README-French.md)), German ([README-German.md](README-translated/README-German.md)), Indonesian ([README-Indonesian](README-translated/README-Indonesian.md)), Italian ([README-Italian](README-translated/README-Italian.md)), Korean ([README-Korean](README-translated/README-Korean.md)), Portuguese ([README-Portuguese](README-translated/README-Portuguese.md)), and Spanish ([README-Spanish](README-translated/README-Spanish.md)) (listed alphabetically)._

*Total Contributors:*


| Information | Links |
| :--- | :--- |
| **Project** |   |
| **News** |       |
| **Chat with us in Slack** |  |
| **Discuss on GitHub** |   |
| **Build** |     |
| **Cite** |   |

*Welcome to The Turing Way project GitHub repository. This is where all the components of the project are developed, reviewed and maintained.*

_The Turing Way_ is a handbook to reproducible, ethical and collaborative data science.
We involve and support a diverse community of contributors to make data science accessible, comprehensible and effective for everyone.
Our goal is to provide all the information that researchers and data scientists in academia, industry and the public sector need at the start of their projects to ensure that they are easy to reproduce at the end.


*The Turing Way is a book, a community and a global collaboration.*

All stakeholders, including students, researchers, software engineers, project leaders and funding teams, are encouraged to use _The Turing Way_ to understand their roles and responsibility of reproducibility in data science.
You can read the book [online](https://book.the-turing-way.org), contribute to the project as described in our [contribution guidelines](https://github.com/the-turing-way/the-turing-way/blob/main/CONTRIBUTING.md) and re-use all materials ([see the License](https://github.com/the-turing-way/the-turing-way/blob/main/LICENSE.md)). 
**We also invite you to contribute to the translation of _The Turing Way_ into different languages and help make research reproducibility accessible to a wider global audience**. 
If you are interested in contributing, please refer to [the guidelines provided in the book's handbook](https://book.the-turing-way.org/community-handbook/translation.html) and join our collaborative efforts.


*Screenshot of The Turing Way online book ([use this image in a presentation](https://drive.google.com/file/d/1wJR664YECSc8b_RSHeyVjDlHs-Ls9lkc/view?usp=sharing))*

Started in 2019 as a lightly opinionated guide to data science, _The Turing Way_ has since expanded into a series of guides on Reproducible Research, Project Design, Communication, Collaboration and Ethical Research.
Each guide offers chapters on a range of topics covering best practices, guidance and recommendations.
These chapters have been co-authored by contributors who are students, researchers, educators, community leaders, policy-makers and professionals from diverse backgrounds, lived experiences and domain knowledge.

***Our moonshot goal is to make reproducibility "too easy not to do".***

**Table of Contents:**

- [_The Turing Way_](#the-turing-way)
    - [About the Project](#about-the-project)
    - [Contributing](#contributing)
    - [Citing](#citing)
    - [Get in Touch](#get-in-touch)
      - [Email](#email)
      - [Chat](#chat)
      - [Receive Updates](#receive-updates)
  - [Contributors](#contributors)
  - [CROWDIN CONTRIBUTORS](#crowdin-contributors)

🎧 If you prefer an audio introduction to the project, our team member Rachael presented at the [Open Science Fair 2019](https://www.opensciencefair.eu/) in Porto and her demo was recorded by the [Orion podcast](https://orionopenscience.podbean.com/e/the-fair-is-in-town-figshare-the-turing-way-and-open-science-quest-at-the-osfair2019/).
_The Turing Way_ overview starts at minute 5:13.

### About the Project

Reproducible research is necessary to ensure that scientific work can be trusted.
Funders and publishers are beginning to require that publications include access to the underlying data and the analysis code.
The goal is to ensure that all results can be independently verified and built upon in future work.
This is sometimes easier said than done.
Sharing these research outputs means understanding data management, library sciences, software development, and continuous integration techniques: skills that are not widely taught or expected of academic researchers and data scientists. 
As these activities are not commonly taught, we recognise that the burden of requirement and new skill acquisition can be intimidating to individuals who are new to this world.
_The Turing Way_ is a handbook to support students, their supervisors, funders and journal editors in ensuring that reproducible data science is "too easy not to do" even for people who have never worked in this way before.
It will include training material on version control, analysis testing, and open and transparent communication with future users, and build on Turing Institute case studies and workshops.
This project is openly developed and any and all questions, comments and recommendations are welcome at our GitHub repository: <https://github.com/the-turing-way/the-turing-way>.

### Project Governance

_The Turing Way_ is an open collaboration and community-driven project.
Everyone who contributes to this book, no matter how small or big their contributions are, is recognised in this project as a contributor and a community member. 
Contributors to the various Working Groups are considered part of the Maintenance Level Governance.
Chairs or representatives from these groups who take on leadership roles in the project, join the Steering Committee.
Their names are listed in the [Governance Roles document](./GOVERNANCE_ROLES.md).

### Contributing

:construction: This repository is always a work in progress and **everyone** is encouraged to help us build something that is useful to the many. :construction:

Everyone who joins the project is expected to follow our [code of conduct](CODE_OF_CONDUCT.md) and to check out our [contributing guidelines](CONTRIBUTING.md) for more information on how to get started.
We want to meet our contributors where they are.
Therefore, we provide multiple entry points for you to contribute based on your interest, availability or skill requirements.

Please read the [Ways of Working document](./ways_of_working.md) to identify how members of _The Turing Way_ community collaborate with each other and contribute to the project.

![This image shows six of many kinds of contributions that anyone can make. These are: Develop and share, Maintain and improve, Share resources, Review and update, Make it global through translation, and Share best practices](book/figures/README_imgs/README_contributions.png)

*Contributions include development and sharing of new chapters; maintenance and improvement of existing chapters; sharing _The Turing Way_ resources; review and updating of previously developed materials; translating its chapter to help make this project globally accessible, and sharing best practices in research.*

Community members are provided with opportunities to learn new skills, share their ideas and collaborate with others.
They are also given mentorship opportunities in the project as they make their contributions to _The Turing Way_ or other open source projects and are encouraged to mentor new participants of the project.

We have created a [promotion pack](https://github.com/the-turing-way/communications/tree/main/promotion-pack) to help you in presenting and sharing about _The Turing Way_ in your network.

### Citing _The Turing Way_

All materials in _The Turing Way_ are available under a CC-BY 4.0 licence.
For details about citing _The Turing Way_ resources, please refer to the [cite _The Turing Way_ chapter](https://book.the-turing-way.org/foreword/cite) in the Foreword of the book.

The citation for the book will look something like:

> The Turing Way Community. (2022). The Turing Way: A handbook for reproducible, ethical and collaborative research (1.0.2). Zenodo. DOI 10.5281/zenodo.3233853.

The citation for our illustrations will look something like:

> The Turing Way Community, & Scriberia. (2020, March 3). Illustrations from the Turing Way book dashes. Zenodo. http://doi.org/10.5281/zenodo.3332807.

You can cite other assets shared by _The Turing Way_ community using DOI listed in the project's Zenodo community page: [zenodo.org/communities/the-turing-way](https://zenodo.org/communities/the-turing-way).

### Get in Touch

#### Email

You can contact *The Turing Way* team by emailing [theturingway@gmail.com](mailto:theturingway@gmail.com) or [turingway@turing.ac.uk](mailto:turingway@turing.ac.uk).

#### Chat

Connect with others and discuss your ideas on Slack using [this invitation link](https://join.slack.com/t/theturingway/shared_invite/zt-2v7euwuo7-BYstHdKuTNd1ce0puDtBxA).

#### Receive Updates

We have a *buttondown* mailing list to which we send monthly project updates.
Subscribe at <https://buttondown.email/turingway/>.

You can also follow us on [Mastodon](https://fosstodon.org/@turingway), [Bluesky](https://bsky.app/profile/turingway.bsky.social) and [Linkedin](https://www.linkedin.com/company/the-turing-way/).