Skip to content

Commit

Permalink
10 set up contributions guide in GitHub (#48)
Browse files Browse the repository at this point in the history
* update to contributions guide

* pre-commit checks

* fixing spelling
  • Loading branch information
stefanfrench authored Dec 11, 2024
1 parent 5c517b8 commit ebb3d11
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 16 deletions.
45 changes: 43 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,48 @@
# Contributing to mozilla.ai Blueprints

We welcome contributions of all kinds! Whether you're a seasoned developer or just starting out, your help is greatly appreciated.
Thank you for your interest in contributing to this repository! This project is part of the Blueprints initiative, which empowers developers to integrate AI capabilities into their projects using open-source tools and models.

# How to Contribute
We welcome all kinds of contributions, from improving customization, to extending capabilities, to fixing bugs. Your efforts help make Blueprints better and more impactful! Whether you’re an experienced developer or just starting out, your support is highly appreciated.

---

## **How to Contribute**

### **Browse Existing Issues** 🔍
- Check the [Issues](https://github.com/mozilla-ai/document-to-podcast/issues) page to see if there are any tasks you'd like to tackle.
- Look for issues labeled **`good first issue`** if you're new to the project—they're a great place to start.

### **Report Issues** 🐛

- Found a bug? Open a [Bug Report](https://github.com/mozilla-ai/document-to-podcast/issues/new?assignees=&labels=bug&projects=document-to-podcast&template=bug_report.yaml&title=%5BBUG%5D%3A+).
- Provide as much detail as possible, including the steps to reproduce the issue and Expected vs. actual behavior

### **Suggest Features** 🚀
- Have an idea for improving the Blueprint? Open a [Feature Request](https://github.com/mozilla-ai/document-to-podcast/issues/new?assignees=&labels=enhancement&projects=Document-to-podcast&template=feature_request.yaml&title=%5BFEATURE%5D%3A+).
- Share why the feature is important and any alternative solutions you’ve considered.

### **Submit Pull Requests** 💻
- Fork the repository and create a new branch for your changes.
- Ensure your branch is up-to-date with the main branch before submitting the PR
- Please follow the PR template, adding as much detail as possible, including how to test the changes

---

## **Contribution Ideas**

Looking for inspiration? Check out the [Future Features & Contributions page](https://mozilla-ai.github.io/document-to-podcast/future-features-contributions/) to explore meaningful ways you can enhance and extend this Blueprint.
Please also feel free to get involved in this repo's [GitHub Discussions](https://github.com/mozilla-ai/document-to-podcast/discussions) to engage in ideas, get feedback, or ask questions.

---

### **Guidelines for Contributions**

**Coding Standards**
- Follow PEP 8 for Python formatting.
- Use clear variable and function names and add comments to improve readability.

**Testing**
- Test changes locally and in GitHub Codespaces to ensure functionality.

**Documentation**
- Update docs for changes to functionality and maintain consistency with existing docs.
31 changes: 17 additions & 14 deletions docs/future-features-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,31 @@
The Document-to-Podcast Blueprint is an evolving project designed to grow with the help of the open-source community. Whether you’re an experienced developer or just starting, there are many ways you can contribute and help shape the future of this tool.

---
## 🛠️ **This Page is Evolving**
As the community grows, we’ll use this space to highlight contributions, showcase new ideas, and share guidance on expanding the Blueprint ecosystem.

We have some ideas of how this Blueprint can be extended and improved, will be sharing these ideas and request for contributions shortly.
## 🌟 **How You Can Contribute**

---
### 🛠️ **Enhance the Blueprint**
- Check the [Issues](https://github.com/mozilla-ai/document-to-podcast/issues) page to see if there are feature requests you'd like to implement
- Refer to our [Contribution Guide](https://github.com/mozilla-ai/document-to-podcast/blob/main/CONTRIBUTING.md) for more details on contributions

## 🌟 **How You Can Contribute**
### 🎨 **Extensibility Ideas**

This Blueprint is designed to be a foundation you can build upon. By extending its capabilities, you can open the door to new applications, improve user experience, and adapt the Blueprint to address other use cases. Here are a few ideas for how you can expand its potential:

### 💡 **Share Your Ideas**
Got a vision for how this Blueprint could be improved? Share your suggestions through [GitHub Discussions](https://github.com/mozilla-ai/document-to-podcast/discussions). Your insights can help inspire new directions for the project.

### 🛠️ **Enhance the Code**
Dive into the codebase and contribute enhancements, optimizations, or bug fixes. Whether it's a small tweak or a big feature, every contribution helps! Start by checking our Contribution Guide (coming soon).
- **Multi-language podcast generation:** Add support for multi-language podcast generation to expand the reach of this Blueprint.
- **New modalities input:** Add support to the Blueprint to be able to handle different input modalities, like audio or images, enabling more flexibility in podcast generation.
- **Improved audio quality:** Explore and integrate more advanced open-source TTS frameworks to enhance the quality of generated audio, making podcasts sound more natural.


We’d love to see how you can enhance this Blueprint! If you create improvements or extend its capabilities, consider contributing them back to the project so others in the community can benefit from your work. Check out our [Contributions Guide](https://github.com/mozilla-ai/document-to-podcast/blob/main/CONTRIBUTING.md) to get started!

### 💡 **Share Your Ideas**
Got an idea for how this Blueprint could be improved? You can share your suggestions through [GitHub Discussions](https://github.com/mozilla-ai/document-to-podcast/discussions).

### 🌍 **Build New Blueprints**
This project is part of a larger initiative to create a collection of reusable starter code solutions that use open-source AI tools. If you’re inspired to create your own Blueprint, we’d love to see it!
This project is part of a larger initiative to create a collection of reusable starter code solutions that use open-source AI tools. If you’re inspired to create your own Blueprint, you can use the [Blueprint-template](https://github.com/new?template_name=Blueprint-template&template_owner=mozilla-ai) to get started.

---

## 🤝 **Get Involved**
- Visit our [GitHub Discussions](https://github.com/mozilla-ai/document-to-podcast/discussions) to explore ongoing conversations and share your thoughts.

Your contributions help make this Blueprint better for everyone. Thank you for being part of the journey! 🎉
Your contributions help make this Blueprint better for everyone 🎉

0 comments on commit ebb3d11

Please sign in to comment.