Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Update contribution guidelines #598

Merged
merged 2 commits into from
Jun 16, 2022
Merged

[WIP] Update contribution guidelines #598

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b378bc8
Update contribution guidelines
cthoyt May 18, 2022
c384225
Update CONTRIBUTING.md
cthoyt May 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 19 additions & 6 deletions template/CONTRIBUTING.md.jinja2 → template/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,28 @@
## Before you write a new request, please consider the following:
# Requesting new terms

Before you write a new request, please consider the following:

- **Does the term already exist?** Before submitting suggestions for new ontology terms, check whether the term exist, either as a primary term or a synonym term. You can search using [OLS](http://www.ebi.ac.uk/ols/ontologies/{{ project.id }})

## Guidelines for creating GitHub tickets with contributions to the ontology:
## Who can request a term

1. **Write a detailed request:** Please be specific and include as many details as necessary, providing background information, and if possible, suggesting a solution. GOC editors will be better equipped to address your suggestions if you offer details regarding *'what is wrong'*, *'why'*, and *'how to fix it'*.
..

2. **Provide examples and references:** Please include PMIDs for new term requests, and include also screenshots, or URLs illustrating the current ontology structure for other types of requests.
## What constitutes a good new term request

3. **For new term request:** Be sure to provide suggestions for label (name), definition, references, position in hierarchy, etc.
...

## What constitutes a bad new term request that will get rejected?

...

## How to add a new term

### Request a new term _via_ the GitHub [Issue Tracker](https://github.com/{{ project.owner }}/{{ project.repo }}/issues/)

1. **Write a detailed request:** Please be specific and include as many details as necessary, providing background information, and if possible, suggesting a solution. The editors of {{ project.title }} will be better equipped to address your suggestions if you offer details regarding *'what is wrong'*, *'why'*, and *'how to fix it'*.
2. **Provide examples and references:** Please include PMIDs for new term requests, and include also screenshots, or URLs illustrating the current ontology structure for other types of requests.
3. **For new term request:** Be sure to provide suggestions for label (name), definition, references, position in hierarchy, etc.
4. **For updates to relationships:** Provide details of the current axioms, why you think they are wrong or not sufficient, and what exactly should be added or removed.

On behalf of the {{ project.title }} editorial team, Thanks!
## Add a new term by directly editing the ontology