Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 2.34 KB

Contributing to the Second Brain AI Course

Welcome to one of the most comprehensive open-source courses on Generative AI 👋

We deeply appreciate your support for the AI community and future readers 🤗

Ways to Contribute

The course itself is already a comprehensive end-to-end resource.

But as a community project, we weren't able to test the code on all possible scenarios.

Thus, if you find any bugs or improvements, consider supporting future readers by contributing to this course.

A contribution can be:

  • Fixing typos
  • Updating version numbers
  • Fixing fundamental issues, such as Python modules that don't work anymore
  • Clarification in documentation
  • Support for different operating systems (e.g., Windows)

Remember, no contribution is too small. Every improvement helps make this repository an even better resource for the community.

Reporting Issues

Found a problem or have a suggestion? Please create an issue on GitHub, providing as much detail as possible.

Contributing Code or Content

  1. Fork & Branch: Fork the repo and create a branch from main.
  2. Make Changes: Implement your contribution.
  3. Test: Verify your changes work properly.
  4. Follow Style: Match existing code and documentation conventions.
  5. Commit: Write clear, concise commit messages.
  6. Stay Updated: Ensure your code is updated with the main branch before submitting.
  7. Submit PR: Push to your fork and open a pull request.
  8. Review Process: Wait for maintainer review.
  9. Merge: Approved changes will be merged to main.

📍 Official Guide on creating a pull request from a forked GitHub repository or use an LLM for more detailed instructions.

Congratulations! You're now a contributor to the Second Brain AI Assistant open-source course. 🔥

Code Quality and Readability

For high-quality, readable code:

  • Write clean, well-structured code
  • Add helpful comments for complex logic
  • Use consistent formatting
  • Use consistent documentation style
  • Consider using a language model to improve readability

Final Notes

We're grateful for all contributors. Your work helps future readers and the AI community.

Let's make the AI community better together! 🤘