You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,6 +51,23 @@ Please use our [Discussions forum][discussions] to ask general questions or cont
51
51
52
52
Please submit a [Pull Request][pulls] to submit a new term for consideration.
53
53
54
+
#### Term Caching System
55
+
56
+
This project uses an ontology term caching system to improve validation performance and reduce external API calls. When you contribute new ontology mappings:
57
+
58
+
1.**Cache Updates**: Adding new ontology mappings may result in changes to the cache files in the `cache/` directory
59
+
2.**Include Cache Changes**: These cache updates should be included in your Pull Request
60
+
3.**Validation Process**: Run `just validate` before submitting to ensure all ontology mappings are valid
61
+
4.**Cache Structure**: The cache organizes terms by ontology prefix (e.g., `cache/ncit/`, `cache/vo/`) for efficient lookup
62
+
63
+
**Standard Operating Procedure for Contributors:**
64
+
65
+
- When adding enums with `meaning:` annotations pointing to ontology terms:
66
+
- Run validation locally with `just validate`
67
+
- Include any generated cache files in your commit
68
+
- Ensure all ontology IDs are correct (never guess - use [OLS](https://www.ebi.ac.uk/ols4/) to verify)
69
+
- Follow the project's naming conventions (e.g., `UPPER_CASE` for enum values)
0 commit comments