Contribution Guidelines for Jupyter Book on Voice and Speech Research

[meralha]

The Biometrics Jupyter book is designed to be a dynamic repository of knowledge, showcasing our lab's work in voice, speech, and biometrics. We've made some exciting progress and now it's time for everyone to pitch in! Whether you're a seasoned researcher or just starting, your insights are valuable.

How to Contribute

1. Fork & Clone: Fork the main repository and clone it to your local machine.
2. New Branch: Create a new branch for your contribution.
3. Develop Content: Add or modify content. Draw inspiration from the "Inspiration & Suggestions" section and the discussion points from meetings or the biometrics Slack channel.
4. Commit & Push: Commit your changes with descriptive messages and push them to your fork.
5. Pull Request: Submit a PR to the main repository with a description of your contribution.

Inspiration & Suggestions

During our last meeting with Satra, we brainstormed potential contributions:

• Thematic Chapters: Consider creating chapters on topics like nonword repetition models or diarization challenges.
• Case Studies: Integrate case studies where speech research is applied in areas like accessibility or medicine. Fabio's pipelines could be exemplary here.
• Tutorials & Guides: Offer tutorials explaining why certain methods/packages (like those for audio processing) are superior.
• Benchmarks & Metrics: Add sections on benchmarks and metrics such as word error rate, including both quality control and quality assessment methods.
• Project Pipelines: Illustrate robust pipelines and invite contributions to areas we're currently exploring, like Bridge2AI or ReadNet.
• Educational Content: Include content suitable for different levels of sophistication, from high school students to experts (or PhD students preparing for qualification exams).

Structural and Collaborative Considerations

• Living Document: Our book is a living resource. Highlight missing content or areas for expansion as you come across them.
• Custom Structure: We're aiming for a structure that adapts to our growth and can extend to other domains.
• Iterative Process: Don't wait for perfection; post your contributions and we'll refine as needed.
• Branch Protection: We'll implement branch protection rules to maintain quality. Small, reviewable updates are encouraged.

Additional Resources and Support

• Documentation: Refer to Jupyter book documentation for rendering issues.
• Community Support: For questions, start a discussion in the PR comments or reach out to fellow lab members.

Action Items

• Section Wishlist: Outline sections you wish you had access to when you started in this field.
• Project Pipeline Visibility: Help us show the progression of our projects to facilitate new contributors jumping in.

Our collective knowledge and expertise are what will make this Jupyter book a good resource. Let's use this opportunity to share our work. Happy contributing!