Merge pull request #237 from OBOFoundry/contributing

Add CONTRIBUTING.md and COC

CODE_OF_CONDUCT.md

@@ -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](docs/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/

CONTRIBUTING.md

@@ -0,0 +1,96 @@
+# Contributing to Core Ontology for Biology and Biomedicine (COB)
+
+:+1: First of all: Thank you for taking the time to contribute!
+
+The following is a set of guidelines for contributing to COB. 
+These guidelines are not strict rules. Use your best judgment, and feel free to propose 
+changes to this document in a pull request.
+
+## Table Of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [Guidelines for Contributions and Requests](#contributions)
+    * [Reporting problems with the ontology](#reporting-bugs)
+    * [Requesting new terms](#requesting-terms)
+    * [Adding new terms by yourself](#adding-terms)
+- [Best practices](#best-practices)
+    * [How to write a great issue?](#great-issues)
+    * [How to create a great pull/merge request?](#great-pulls)
+
+<a id="code-of-conduct"></a>
+
+## Code of Conduct
+
+The Core Ontology for Biology and Biomedicine team strives to create a
+welcoming environment for editors, users and other contributors.
+Please carefully read our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+<a id="contributions"></a>
+
+## Guidelines for Contributions and Requests
+
+<a id="reporting-bugs"></a>
+
+### Reporting problems with the ontology
+
+Please use our [Issue Tracker](https://github.com/OBOFoundry/COB/issues/) for reporting problems with the ontology. 
+To learn how to write a good issue [see here](#great-issues).
+
+<a id="requesting-terms"></a>
+
+### 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/ols/ontologies/cob).
+- **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/OBOFoundry/COB/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/OBOFoundry/COB/issues/new/choose).
+
+For how to write a good term request, please read the [best practices carefully](#great-issues).
+
+<a id="adding-terms"></a>
+
+### How to add a new term
+
+If you have never editted 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/cob-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. **Important**: When adding a new term which already exists in OBO, we add it using a COB ID, and add the mapping to the original term in the [external mappings](https://github.com/OBOFoundry/COB/blob/master/src/ontology/components/cob-to-external.tsv) file.
+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?
+
+Please refer to the [OBO Academy best practices](https://oboacademy.github.io/obook/lesson/term-request/).
+
+<a id="great-pulls"></a>
+
+### 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/)

docs/contact.md

@@ -0,0 +1,5 @@
+## Contact the COB team
+
+In most cases, the best way to reach the COB team is on the [issue tracker](https://github.com/OBOFoundry/COB/issues).
+
+For private messages, the primary contact is documented here https://obofoundry.org/ontology/cob.html.