Skip to content

Commit 304e415

Browse files
committed
add: CONTRIBUTING.md
1 parent 657522c commit 304e415

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

CONTRIBUTING.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing to TrainCheck
2+
3+
Thank you for your interest in contributing to TrainCheck. This project is actively maintained, and we welcome contributions from the community.
4+
5+
## 🧩 Areas for Contribution
6+
7+
We encourage contributions in the following areas:
8+
9+
- 🛠️ **Core Features**: Implementation of new invariant types, enhanced instrumentation, and improved fault localization.
10+
- ⚙️ **Framework Support**: Expanding compatibility with DeepSpeed, HuggingFace Trainer, and multi-GPU environments.
11+
- 📖 **Documentation**: Creating usage guides, walkthroughs, and clarifications (documentation is currently limited).
12+
- 🔍 **Testing**: Adding realistic traces and increasing coverage for components that are not thoroughly tested.
13+
- 🚧 **Engineering Improvements**: Enhancing log formatting, improving CLI usability, and performing code cleanup.
14+
15+
**For specific tasks and upcoming features where we need assistance, please see our [ROADMAP (TBD)](./ROADMAP.md) for planned directions and priorities.**
16+
17+
## ⚠️ Important Information for Contributors
18+
19+
**TrainCheck** is structured as a standard Python library. Please follow conventional Python development practices.
20+
21+
- **Code Style**: Install the pre-commit hooks in your development environment:
22+
```bash
23+
pip install pre-commit
24+
pre-commit install
25+
pip install isort
26+
```
27+
- **Documentation**: The documentation is currently under development. If you have any questions or require clarification, please join our Discord server via the [README](./README.md).
28+
- **Testing**: The test structure is being finalized (see TEST.md (TBD)). In the interim, you are welcome to add unit or end-to-end tests in the `tests/` directory as appropriate.
29+
30+
## 💬 Questions?
31+
32+
Join our Discord server (see [README](./README.md)) — don’t hesitate to ping us there. We’d love to help you get started.
33+
34+

0 commit comments

Comments
 (0)