Skip to content

Add CONTRIBUTING.md #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
onchito-walks wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add CONTRIBUTING.md #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing to BitNet

Contributions to BitNet are welcome! This project explores 1-bit LLM inference.

## How to Contribute

### Reporting Bugs
- Search existing issues first
- Include Python version, OS, and GPU info
- Provide minimal reproduction steps

### Submitting Code
1. Fork this repository
2. Create a feature branch
3. Write clean, well-documented Python code
4. Add tests for new functionality
5. Run `pytest` to verify all tests pass
6. Open a Pull Request

### Code Style
- Follow PEP 8
- Use type hints where possible
- Add docstrings to public functions
- Keep functions focused and small

### Research Contributions
- Link to relevant papers
- Provide experimental results with reproducible configs
- Document hardware requirements

## Questions?

Open an issue or discussion on this repo.