|
| 1 | +# Contributing to Voc4Cat |
| 2 | + |
| 3 | +Thank you for your interest in contributing to the Voc4Cat vocabulary! This SKOS vocabulary covers catalysis disciplines and welcomes contributions from the community. |
| 4 | + |
| 5 | +## Quick Start |
| 6 | + |
| 7 | +1. **Download** the current vocabulary Excel file: [voc4cat.xlsx](https://nfdi4cat.github.io/voc4cat/dev/voc4cat.xlsx) |
| 8 | +2. **Edit** the Excel file to add/modify concepts |
| 9 | +3. **Request ID range** (for new concepts): [Create an issue](https://github.com/nfdi4cat/voc4cat/issues/new/choose) |
| 10 | +4. **Submit** your Excel file in a pull request: |
| 11 | + - Place file in `inbox-excel-vocabs/` folder |
| 12 | + - Keep the filename as `voc4cat.xlsx` |
| 13 | + - Describe your changes in the PR description |
| 14 | + |
| 15 | +## Important Guidelines |
| 16 | + |
| 17 | +- **Small contributions welcome**: Even single concept additions are valuable |
| 18 | +- **Break up large changes**: Split contributions of 50+ concepts into smaller chunks (~20 changes each) |
| 19 | +- **Use Excel workflow only**: Never edit Turtle (.ttl) files directly |
| 20 | +- **ID ranges required**: Request your ID range before adding new concepts |
| 21 | + |
| 22 | +## Documentation |
| 23 | + |
| 24 | +For detailed guidelines and step-by-step instructions, see: |
| 25 | + |
| 26 | +- **[Current Vocabulary Guidelines](https://nfdi4cat.github.io/voc4cat/docs_usage/guidelines.html)** |
| 27 | +- **[Step-by-step Guide (PDF)](https://zenodo.org/records/13757351)** - Visual walkthrough of the process |
| 28 | +- **[Vocabulary Guidelines V2.0](https://doi.org/10.5281/zenodo.13773255)** - Academic publication on Zenodo |
| 29 | + |
| 30 | +## What Happens Next? |
| 31 | + |
| 32 | +(next after quick start) |
| 33 | + |
| 34 | +1. CI/CD pipeline automatically processes your Excel file |
| 35 | +2. Turtle files are generated and validated |
| 36 | +3. Updated Excel file is created from the processed data |
| 37 | +4. Reviewers will check your contribution |
| 38 | +5. Upon approval, your changes are merged and published |
| 39 | + |
| 40 | +## Questions or Issues? |
| 41 | + |
| 42 | +- **Vocabulary discussions**: [Create an issue](https://github.com/nfdi4cat/voc4cat/issues) |
| 43 | +- **Tooling improvements**: [voc4cat-tool issues](https://github.com/nfdi4cat/voc4cat-tool/issues) |
| 44 | +- **Template feedback**: [voc4cat-template issues](https://github.com/nfdi4cat/voc4cat-template/issues) |
| 45 | + |
| 46 | +## License |
| 47 | + |
| 48 | +All vocabulary contributions are released under CC0-1.0 license (public domain). |
0 commit comments