Skip to content

🚀 Contributing to ShinuAILabs-MasteryHub

Thank you for considering contributing! This is a community-driven project, and every contribution — big or small — makes a difference.

Ways to Contribute

📝 Content Contributions

  • Fix typos & broken links — The quickest way to help!
  • Improve existing modules — Add examples, clarify explanations, fix errors.
  • Add new modules — Propose a new topic for the QE-AI-Track or Playwright-Pro-Track.

💻 Code Contributions

  • MkDocs theme improvements — Fix styling, add features to the site.
  • Automation scripts — Help with CI/CD, build tooling, or content validation.
  • New tools — Build AI-powered tools for the QE community.

📢 Community Contributions

  • Review & discuss — Comment on open issues and pull requests.
  • Share use cases — How has this content helped you? Inspire others.
  • Translate — Help make content accessible in other languages.

Getting Started

  1. Fork the repository.
  2. Clone your fork:
    git clone https://github.com/YOUR_USERNAME/ShinuAILabs-MasteryHub.git
    
  3. Create a branch:
    git checkout -b my-improvement
    
  4. Make your changes.
  5. Commit & push:
    git commit -m "Description of changes"
    git push origin my-improvement
    
  6. Open a Pull Request against the main branch.

Content Style Guide

  • Write in clear, concise English.
  • Use ## for section headings (one level per topic).
  • Use code blocks with language tags for all code snippets.
  • Keep line lengths under 100 characters in Markdown.
  • Link to external references using [text](url) format.
  • Place new modules under the appropriate track directory.

Pull Request Process

  1. Keep PRs focused — one feature/change per PR.
  2. Update the relevant README.md if adding new modules.
  3. Ensure links work before submitting.
  4. A maintainer will review within a few days.

License

By contributing, you agree that your contributions will be licensed under the MIT License.


Built with ❤️ by the community