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.

• 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.

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/!

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

• 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.

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

• 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

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

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!