From bda1d81d6cfdf10252b19dfaaa08a8d838abf159 Mon Sep 17 00:00:00 2001 From: onchito-walks Date: Mon, 11 May 2026 07:34:10 -0400 Subject: [PATCH] Add CONTRIBUTING.md --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..974b9f877 --- /dev/null +++ b/CONTRIBUTING.md @@ -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.