Upload CONTRIBUTING.md with huggingface_hub
Browse files- CONTRIBUTING.md +45 -0
CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Contributing to the Scandium Dataset
|
| 2 |
+
|
| 3 |
+
We welcome contributions that improve the quality, coverage, or usability of the dataset.
|
| 4 |
+
|
| 5 |
+
## How to Contribute
|
| 6 |
+
|
| 7 |
+
### Reporting Issues
|
| 8 |
+
- Use the GitHub issue tracker
|
| 9 |
+
- Include the entry formula and source_id if reporting a data issue
|
| 10 |
+
- Include the release version
|
| 11 |
+
|
| 12 |
+
### Suggesting Improvements
|
| 13 |
+
- Open an issue with the "enhancement" label
|
| 14 |
+
- Describe the problem and your proposed solution
|
| 15 |
+
|
| 16 |
+
### Adding Data
|
| 17 |
+
- We do not accept direct additions to the curated dataset
|
| 18 |
+
- New sources go through the full validation pipeline
|
| 19 |
+
- Contact us to discuss new source integration
|
| 20 |
+
|
| 21 |
+
### Code Contributions
|
| 22 |
+
- Fork the repository
|
| 23 |
+
- Create a feature branch
|
| 24 |
+
- Submit a PR with a clear description of changes
|
| 25 |
+
- Ensure all validation passes
|
| 26 |
+
|
| 27 |
+
## Development Setup
|
| 28 |
+
|
| 29 |
+
```bash
|
| 30 |
+
git clone https://github.com/Scandium-Labs/Scandium-Dataset
|
| 31 |
+
cd Scandium-Dataset
|
| 32 |
+
pip install -r requirements.txt
|
| 33 |
+
```
|
| 34 |
+
|
| 35 |
+
## Validation Requirements
|
| 36 |
+
|
| 37 |
+
Before submitting, ensure:
|
| 38 |
+
1. No duplicate entries introduced
|
| 39 |
+
2. All new entries pass the validated tier gates
|
| 40 |
+
3. Cross-source agreement is documented
|
| 41 |
+
4. Tests pass
|
| 42 |
+
|
| 43 |
+
## Code of Conduct
|
| 44 |
+
|
| 45 |
+
All contributors must follow our [Code of Conduct](CODE_OF_CONDUCT.md).
|