Skip to content

Conversation

@yurekami
Copy link
Contributor

Summary

Add a comprehensive CONTRIBUTING.md guide to help new contributors understand how to contribute to DeepGEMM.

Contents

Getting Started

  • Prerequisites (GPU, CUDA, Python, PyTorch requirements)
  • Development setup instructions
  • How to run tests

How to Contribute

  • Reporting bugs (with link to issue template)
  • Suggesting features (with link to issue template)
  • Submitting pull requests (step-by-step guide)

Code Style

  • C++ code guidelines
  • Python code guidelines (PEP 8, type hints)

Project Structure

  • Overview of the repository layout
  • Description of key directories

Additional Info

  • Testing requirements
  • License information

Why This Matters

A good contributing guide helps:

  • Lower the barrier for new contributors
  • Ensure consistent code quality
  • Reduce back-and-forth on PRs
  • Build a healthy open source community

This complements the issue templates added in PR #248.

🤖 Generated with Claude Code

Add a comprehensive contributing guide to help new contributors
understand how to set up their development environment, submit
issues, and create pull requests.

Contents:
- Prerequisites and development setup instructions
- How to report bugs and suggest features
- Pull request guidelines
- Code style guidelines for C++ and Python
- Project structure overview
- Testing requirements

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@zheanxu zheanxu closed this Jan 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants