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.

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

Update CONTRIBUTING.md and add CODE_OF_CONDUCT.md #744

Merged
merged 6 commits into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
46 changes: 46 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by [contacting the project team](contact.md). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This code of conduct has been derived from the excellent code of conduct of the [ATOM project](https://github.com/atom/atom/blob/master/CODE_OF_CONDUCT.md) which in turn is adapted from the [Contributor Covenant][homepage], version 1.4, available at [https://contributor-covenant.org/version/1/4][version]

[homepage]: https://contributor-covenant.org
[version]: https://contributor-covenant.org/version/1/4/
109 changes: 97 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,89 @@
# How to contribute to this project
# Table Of Contents

Please use our tracker for requests for new relations, modifications, clarifications, etc.
- [Table Of Contents](#table-of-contents)
- [Contributing to Relation Ontology (RO)](#contributing-to-relation-ontology-ro)
anitacaron marked this conversation as resolved.
Show resolved Hide resolved
- [Code of Conduct](#code-of-conduct)
- [Guidelines for Contributions and Requests](#guidelines-for-contributions-and-requests)
- [Reporting problems with the ontology](#reporting-problems-with-the-ontology)
- [Requesting new terms](#requesting-new-terms)
- [Who can request a term?](#who-can-request-a-term)
- [How to write a new term request](#how-to-write-a-new-term-request)
- [How to add a new term](#how-to-add-a-new-term)
- [Best Practices](#best-practices)
- [How to write great issues?](#how-to-write-great-issues)
- [How to create a great pull/merge request?](#how-to-create-a-great-pullmerge-request)
- [RO mailing list](#ro-mailing-list)
- [RO working group meetings](#ro-working-group-meetings)

https://github.com/oborel/obo-relations
## Contributing to Relation Ontology (RO)

Creating a new issue in the tracker allows the RO editors and community to discuss proposed changes, fixes, or additions. If you'd like faster turnaround on your request, and you know how to use GitHub, please specify your desired changes by submitting a GitHub Pull Request on the appropriate file.
First of all: Thank you for taking the time to contribute!

## Before you write a new request, please consider the following:
The following is a set of guidelines for contributing to RO.
These guidelines are not strict rules. Use your best judgment, and feel free to propose
changes to this document in a pull request.

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

## Guidelines for creating GitHub tickets with contributions to the ontology:
The RO team strives to create a welcoming environment for editors, users and other contributors.
Please carefully read our [Code of Conduct](CODE_OF_CONDUCT.md).

## Guidelines for Contributions and Requests


### Reporting problems with the ontology

Please use our [Issue Tracker](https://github.com/oborel/obo-relations/issues/) for reporting problems with the ontology.
To learn how to write a good issue [see here](#best-practices).


### 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 for your term using [OLS](http://www.ebi.ac.uk/ols4/ontologies/ro).
- **Can you provide a definition for the term?** It should be very clear what the term means, and you should be
able to provide a concise definition, ideally with a scientific reference.
- **Is the ontology in scope for the term?** Sometimes, it is hard to tell whether a term "belongs" in
and ontology. A rule of thumb is "if a similar term already exists, the new term is probably in scope."
It can be very helpful to mention a very similar concept as part of the term request!

#### Who can request a term?

Anyone can request new terms. However, there is not guarantee that your term will be added automatically. Since this is a
community resource, it is often necessary to do at least some of the work of adding the term yourself, see below.

#### How to write a new term request

Request a new term _via_ the GitHub [Issue Tracker](https://github.com/oborel/obo-relations/issues/).

It is important to remember that it takes a lot of time for curators to process issues submitted to the tracker.
To make this work easier, please always use issue templates if they are available (https://github.com/oborel/obo-relations/issues/new/choose).

For how to write a good term request, please read the [best practices carefully](#best-practices).

<a id="adding-terms"></a>

### How to add a new term

If you have never edited this ontology before, first follow a [general tutorial](https://oboacademy.github.io/obook/lesson/contributing-to-obo-ontologies)

**Process**:

1. Clone the repository (In case you are not an offical team member, create a fork first)
1. Create new branch in git, for example `git checkout -b issue123`
1. Open src/ontology/ro-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_!
1. Perform your edit and save your changes
1. Commit changes to branch
1. Push changes upstream
1. Create pull request

## Best Practices

<a id="great-issues"></a>

### How to write great 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. GOC editors will be better equipped to address your suggestions if you offer details regarding *'what is wrong'*, *'why'*, and *'how to fix it'*.

Expand All @@ -20,12 +93,24 @@ Creating a new issue in the tracker allows the RO editors and community to discu

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.

Creating a new issue in the tracker allows the RO editors and community to discuss proposed changes, fixes, or additions.

Please refer to the [OBO Academy best practices](https://oboacademy.github.io/obook/lesson/term-request/).

### How to create a great pull/merge request?

Please refer to the [OBO Academy best practices](https://oboacademy.github.io/obook/howto/github-create-pull-request/)

## Guidelines for creating Pull Requests

Anyone is welcome to make Pull Requests (PRs), however, you are advised to coordinate with other RO developers and announce your
intentions on the relevant GitHub issue first to avoid doing work that may later be rejected. The `#relation-ontology` channel on
OBO slack is also a good place to discuss PRs.

In RO, all PRs must be approved by *two* RO editors.

## RO mailing list
Visit http://groups.google.com/group/obo-relations to join the (low-traffic) RO mailing list.

## RO working group meetings
Currently (January 2022) the RO working group meets once every 8 weeks on Tuesdays at 9am PT / 12pm ET. These meetings are open to the community. Please join the [RO mailing list](http://groups.google.com/group/obo-relations) to be informed about upcoming meetings.

##

Thank you for contributing to RO!
Currently (August 2023) the RO working group meets once every 4 weeks on Mondays at 8am PT / 11am ET. These meetings are open to the community. Please join the [RO mailing list](http://groups.google.com/group/obo-relations) to be informed about upcoming meetings.
Loading