⚠️The Turing Way is moving domain! We will soon move to book.the-turing-way.org. You can use new domain now! Later, the old domain will redirect you to the new location.

Frequently Asked Questions

Contents

Frequently Asked Questions#

Meeting you where you are.

In this document, we provide an overview of resources and ways of working in the community. Although, most of these resources are described in different chapters, you can always return to this page to find quick access to useful pointers and links.

You can get started by exploring different opportunities listed on our start page.

1. Getting to Know the Project#

You might be wondering	You can learn about that here
Where can I browse its resources and chapters?	Check out the Online Book
Where are the raw files for these chapters stored?	Online on GitHub repository
How Can I get updates regularly?	Follow us on social platform as listed on our start page
Is there a dedicated chat system for the community?	Join the Slack workspace.
Are there monthly updates I can receive?	We send newsletters monthly: subscribe here.
What happened in the project last year?	Read previous reports in the project communication folder.
Are there some presentations I can look at?	You can find them linked to this chapter.
I don’t feel like reading, can I watch short videos?	Here is a YouTube playlist with short videos.
Where can I learn about the next community event that I can join?	We share them regularly in our monthly newsletters.

2. Documentation and Participation Guidelines#

You might be wondering	You can learn about that here
Can I use its resources without being a part of this project?	Yes! The book is available for free under CC-BY License.
What is expected of me if I participate in the community?	Please read and abide by the Code of Conduct.
Is there a guideline for people to contribute to the GitHub repository?	We have a Contribution Guideline.
I am super new to GitHub. How does it work?	See this chapter on Getting Started with GitHub
Is there a recommended format for the chapters?	Yes. Please see this Style guide and recommendations on how to Maintain Consistency
Are there any templates and supporting materials for people writing chapters?	Here are some templates and workflows for Contributing and Developing Chapters

3. Contributing#

You might be wondering	You can learn about that here
What kind of topics are in the scope for The Turing Way?	Any topic in research and data science practices that fit in these guides: Reproducible Research, Project Design, Communication, Collaboration, Ethical Research
Where can I learn more about the community?	We have Community Handbook describing these aspects.
What ideas, resources or improvements in the book are being suggested by others?	Browse open issues on GitHub
What contributions are currently being made by others?	Browse open Pull Requests (PR) on GitHub
How do people interact with each other when reviewing contributions?	Click on an open PR that has been commented on to see how people exchange ideas and feedback. See this example. Also, join our Slack Workspace to be part of conversations.

4. Participating Synchronously#

Note: Find out about the latest events in our monthly newsletters.

Types of calls/meetings	How
What is a Online Collaboration Cafe?	These are open coworking calls for anyone interested in collaborating with The Turing Way members. These take place every first and third Wednesday of each month, 15:00 - 17:00 UK time.
The Turing Way Book Dashes	These are a week-long events organised twice a year. Participants are selected through open calls for applications.
What is a Fireside Chat?	These public online events are organised frequently to feature open discussions and panels with experts, champions and their projects in reproducibility, open research, ethics, collaboration and other opportunities in data science and research.
What is a Community Forum?	These online calls bring together any member of the community - including people who have not yet contributed to The Turing way. Our aim is to leverage the expertise across our community and we explicitly invite you to review our processes and recommend improvements in our decision-making.
What are onboarding calls?	These calls are hosted every two months, join us to connect with other new members of the community and learn more about the project.
Are there Working Group Meetings?	Different Working Groups meet regularly to discuss and work on specific areas of their interest in The Turing way. Anyone interested in their work can contact the chair to join these calls.
Can I meet community members at in-person events?	Our community members often attend several events/conferences where you can plan to join them! You can connect with the team abd community on Slack workspace.

5. Participating Asynchronously#

You might be wondering this	You can learn about that here
Can I see what people are discussing about without having to participate right now?	You are welcome to read comments on GitHub and visit Slack channels without joining the conversation.
Oh! However I have some thoughts and feedback on an ongoing discussion.	Great! Why wait? Join the conversation. We would be delighted to welcome your thoughts.
I read a chapter and want to clarify a minor technical/conceptual thing. Can I simply ask it without opening an issue?	Yes. Please ask away on a suitable Slack channel.
I saw a typo or factual error in a chapter, how can I fix it?	(i) You can raise the error by opening a GitHub issue. (ii) You can also directly fix the error by using the ‘suggest edit’ option on Netlify, which will help in opening a Pull Request. (iii) If you get stuck, ask for help in troubleshooting on Slack.
I am not very comfortable with GitHub, I don’t want to do something wrong on the repository. Help!	We can assure you that you will not ‘break’ the GitHub repository. Everything there is reversible, thanks to `git` version control system. We encourage you to try out GitHub by fixing some minor errors marked as good first issues.
I want to report a bug.	Use the bug report issue template.
I have an idea for a chapter, how should I share it?	You can open an issue using this issue template for a new chapter to describe your idea.
Do I have to write the whole chapter when I propose an idea?	You can always invite contributions from others. Do as little as you can, or as much as you would like.
I saw someone working on a topic that I know a few things about. Can I collaborate in their Pull Request or issue?	Please do comment under the appropriate issue of Pull Request to indicate your interest in collaborating. You can offer your support to review the chapter or co-write the chapter. You can also contribute by creating illustrations or helping add references.

6. Receiving Acknowledgement#

You might be wondering this	You can learn about that here
I just contributed to The Turing Way, am I a contributor now?	Yes, you will be added as a contributor to The Turing Way using all-contributors bot. Your name will appear on our Contributors table.
My contribution to The Turing Way was not on GitHub, will I still be acknowledged?	Absolutely! The all-contributors bot allows us to give attribution to people even when they don’t work on GitHub. You might however need a GitHub account.
Can I describe my contributions in detail?	Yes! We have a dedicated page contributors.md where you are encouraged to create an entry with your name, bio and description of your contribution. This is published in the afterword of the book as Contributors Record.
My research project collaborated with The Turing Way. Can I mention it somewhere?	We have a contributing project document where our collaborating projects, organisations and sponsors are listed. You can describe your project in this document.
My organisation supports by participation in The Turing Way. Can I mention it somewhere?	We have a contributing project document where our collaborating projects, organisations and sponsors are listed. You can describe your organisation with your profile in this document.

Have more questions that are not covered here? Ask us directly via the communication channels listed in the table above. Check out the next subchapters to read what motivations others have for working on the project, what other community initiatives are led by them and how you can stay involved.