Skip to content
@open-cmuq

Open-CMUQ

The open-cmuq project is a faculty & student driven initiative to empower students to contribute to open source software, developed in-house for CMUQ

Welcome to the CMUQ Open Source Organization

The open-cmuq project is a faculty & student driven initiative to empower students to contribute to open source software, developed in-house for the CMU-Qatar community. This is where you will find new projects we are building in summers, and old projects we are maintaining / looking for maintainers to champion and own.

🎯 Our Mission

  • Promote Open-Source Culture: Foster a community where open-source collaboration thrives at Carnegie Mellon University in Qatar.
  • Sustain Student Projects: Ensure that student-created software remains accessible and maintainable for future generations.
  • Engage Students: Provide opportunities for students to work on meaningful projects during their free time, especially in the summer.

📚 Get Involved

Whether you're a seasoned developer or just starting out, we welcome you to join us:

  1. Explore Our Projects: Browse our repositories to find projects that interest you.
  2. Join the Discussion: Participate in discussions, report issues, or suggest new features.
  3. Contribute Code: Follow our contribution guidelines to submit pull requests.
  4. Visit our website at https://open-cmuq.github.io/!

🛠 Organization Guidelines

To maintain quality and consistency across all projects, we've established some simple guidelines.

1️⃣ Project Essentials

  • README.md: Every project must include a README with:
    • Project description
    • Installation instructions
    • Usage examples
    • License information
  • CONTRIBUTING.md: Guidelines on how to contribute, including at least one issue labeled good first issue to help newcomers in Github Issues page.
  • License: Choose either the MIT License or GNU GPL v2 for your project.

2️⃣ Code Style

  • Follow language-specific conventions (e.g., PEP 8 for Python).
  • Keep code clean and well-documented.
  • Use comments to explain complex sections.

3️⃣ Commit Messages

  • Write clear and descriptive commit messages.
  • Follow this simple format:

Type: Short description Optional detailed explanation

  • Types can be:

  • feat: New feature

  • fix: Bug fix

  • docs: Documentation changes

  • style: Code formatting (no code change)

  • refactor: Code changes without fixing bugs or adding features

  • test: Adding or updating tests

  • chore: Maintenance tasks

Refer to https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53 For more information on commit msg details

4️⃣ Collaboration Norms

  • Be respectful and inclusive.
  • Review existing issues before opening new ones.
  • Provide constructive feedback during code reviews.

🏫 About CMUQ

Carnegie Mellon University in Qatar is committed to innovation and excellence. This organization is part of our effort to extend learning beyond the classroom and into the global developer community.

Special Thanks to the founding team:

  • Talhah Peerbhai
  • Adib Pahlowan
  • Mateo Correa
  • Tra Bui
  • Mohamed Elzeni
  • Mohamed Shikfa

Join us and make a lasting impact!


Popular repositories Loading

  1. YallaEvents YallaEvents Public

    A hybrid mobile app for students to always be up to date about the events happening on campus organized either by clubs or departments.

    C++ 2 3

  2. CountsFor CountsFor Public

    A web application designed to assist CMUQ faculty in analyzing and planning courses that fulfill requirements across the four majors at CMU-Q. It includes a backend for data processing and API, a f…

    Python 1 1

  3. .github .github Public

    The open-cmuq project is a faculty & student driven initiative to empower students to contribute to open source software, developed in-house for the CMU-Qatar community. This is where you will find…

  4. qrdi-arg-latex-template qrdi-arg-latex-template Public

    LaTeX template for ARG grant proposals

    Makefile

  5. csdq csdq Public

    Public website For the computer science department in Carnegie Mellon Qatar.

    TypeScript 4

  6. open-cmuq.github.io open-cmuq.github.io Public

    Website for OpenCMUQ Collectives club at Carnegie Mellon University in Qatar.

    Astro 1

Repositories

Showing 10 of 10 repositories

Top languages

Loading…

Most used topics

Loading…