Skip to content

Commit 3f940e1

Browse files
chore: Initial seed setup of MICROSTRUCTURE ontology
Auto-generated via 'Setup New Ontology' GitHub Actions workflow: - Configured project-odk.yaml (URI base: https://w3id.org/pmd/microstructure/) - imports-edit.owl aggregates all *_import.owl modules - microstructure-shared.owl imports imports-edit.owl (shared base for all components) - Each microstructure-{component}.owl imports microstructure-shared.owl with annotations - microstructure-axioms-shared.owl imports ALL unique component files (no duplicates) - Generated microstructure-edit.owl (ontology source) and microstructure-idranges.owl - Initialized ROBOT template TSV files in src/templates/
1 parent caf5df7 commit 3f940e1

51 files changed

Lines changed: 4089 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CONTRIBUTING.md

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Contributing to DiStEL Microstructure Ontology
2+
3+
:+1: First of all: Thank you for taking the time to contribute!
4+
5+
The following is a set of guidelines for contributing to MICROSTRUCTURE.
6+
These guidelines are not strict rules. Use your best judgment, and feel free to propose
7+
changes to this document in a pull request.
8+
9+
## Table Of Contents
10+
11+
- [Guidelines for Contributions and Requests](#contributions)
12+
* [Reporting problems with the ontology](#reporting-bugs)
13+
* [Requesting new terms](#requesting-terms)
14+
* [Adding new terms by yourself](#adding-terms)
15+
- [Best practices](#best-practices)
16+
* [How to write a great issue?](#great-issues)
17+
* [How to create a great pull/merge request?](#great-pulls)
18+
19+
<a id="contributions"></a>
20+
21+
## Guidelines for Contributions and Requests
22+
23+
<a id="reporting-bugs"></a>
24+
25+
### Reporting problems with the ontology
26+
27+
Please use our [Issue Tracker](https://github.com/materialdigital/materialdigital/microstructure-ontology/issues/) for reporting problems with the ontology.
28+
To learn how to write a good issue [see here](#great-issues).
29+
30+
<a id="requesting-terms"></a>
31+
32+
### Requesting new terms
33+
34+
Before you write a new request, please consider the following:
35+
36+
- **Does the term already exist?** Before submitting suggestions for new ontology terms, check whether the term exist,
37+
either as a primary term or a synonym term. You can search for your term using [OLS](http://www.ebi.ac.uk/ols/ontologies/microstructure).
38+
- **Can you provide a definition for the term?** It should be very clear what the term means, and you should be
39+
able to provide a concise definition, ideally with a scientific reference.
40+
- **Is the ontology in scope for the term?** Sometimes, it is hard to tell whether a term "belongs" in
41+
and ontology. A rule of thumb is "if a similar term already exists, the new term is probably in scope."
42+
It can be very helpful to mention a very similar concept as part of the term request!
43+
44+
#### Who can request a term?
45+
46+
Anyone can request new terms. However, there is not guarantee that your term will be added automatically. Since this is a
47+
community resource, it is often necessary to do at least some of the work of adding the term yourself, see below.
48+
49+
#### How to write a new term request
50+
51+
Request a new term _via_ the GitHub [Issue Tracker](https://github.com/materialdigital/materialdigital/microstructure-ontology/issues/).
52+
53+
It is important to remember that it takes a lot of time for curators to process issues submitted to the tracker.
54+
To make this work easier, please always use issue templates if they are available (https://github.com/materialdigital/materialdigital/microstructure-ontology/issues/new/choose).
55+
56+
For how to write a good term request, please read the [best practices carefully](#great-issues).
57+
58+
<a id="adding-terms"></a>
59+
60+
### How to add a new term
61+
62+
If you have never editted this ontology before, first follow a [general tutorial](https://oboacademy.github.io/obook/lesson/contributing-to-obo-ontologies)
63+
64+
**Process**:
65+
66+
1. Clone the repository (In case you are not an offical team member, create a fork first)
67+
1. Create new branch in git, for example `git checkout -b issue123`
68+
1. Open src/ontology/microstructure-edit.owl in your favourite editor, i.e. [Protege](https://protege.stanford.edu/). **Careful:** double check you are editing the correct file. There are many ontology files in this repository, but only one _editors file_!
69+
1. Perform your edit and save your changes
70+
1. Commit changes to branch
71+
1. Push changes upstream
72+
1. Create pull request
73+
74+
## Best Practices
75+
76+
<a id="great-issues"></a>
77+
78+
### How to write great issues?
79+
80+
Please refer to the [OBO Academy term request guide](https://oboacademy.github.io/obook/howto/term-request/).
81+
82+
<a id="great-pulls"></a>
83+
84+
### How to create a great pull/merge request?
85+
86+
Please refer to the [OBO Academy best practices](https://oboacademy.github.io/obook/howto/github-create-pull-request/)

issue_template.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
For new term requests, please provide the following information:
2+
3+
## Preferred term label
4+
5+
(e.g., Asplenia)
6+
7+
## Synonyms
8+
9+
(e.g., Absent spleen)
10+
11+
## Textual definition
12+
13+
the definition should be understandable even for non-specialists. Include a PubMed ID to refer to any relevant article that provides additional information about the suggested term.
14+
15+
## Suggested parent term
16+
17+
Please look in the hierarchy in a browser such as [OLS](http://www.ebi.ac.uk/ols/ontologies/microstructure)
18+
19+
## Attribution
20+
21+
If you would like a nanoattribution, please indicate your ORCID id

0 commit comments

Comments
 (0)