Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 2.09 KB

Contributing to CodeCampus User Guide

First off, thank you for considering contributing to the CodeCampus User Guide! It's people like you that make CodeCampus a great resource for students worldwide.

📜 Our Vision

We aim to provide the best possible documentation for beginner software engineers. We don't just want to list commands; we want to teach the "Why" and the "How" of professional development.

🛠️ How Can I Contribute?

1. Reporting Bugs

2. Suggesting Enhancements

  • If you think a tool or workflow is missing, open an issue to discuss it.

3. Adding or Improving Documentation

This is the most impactful way to contribute! However, we have strict quality standards. All new tool documentation MUST follow the Antigravity.md Specification.

Every tool description must include:

  1. What is it?: Conceptual, beginner-friendly explanation.
  2. Installation: Proper tabs for Ubuntu, Arch, Fedora, and openSUSE.
  3. Why this tool matters (In Depth): The most important part—explain the "Why."
  4. How students will actually use it: Practical, concrete examples.
  5. Professional Insight: Senior-level tips and pitfalls to avoid.

🚀 Style Guide

  • Professional Tone: Avoid slang and emojis in the documentation body.
  • Direct Language: Be concise and avoid filler words.
  • Markdown Headers: Use only #, ##, and ### appropriately.
  • No Marketing: We are here to teach, not to sell.

📬 Pull Request Process

  1. Fork the repo and create your branch from main.
  2. If you've added code or documentation that should be tested, add tests or verify with mkdocs serve.
  3. Ensure your documentation adheres to the Antigravity.md spec.
  4. Open a Pull Request with a clear description of your changes.

By contributing, you agree that your contributions will be licensed under the project's CodeCompass Personal Use License.

Happy coding! 🚀