Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 3.02 KB

CONTRIBUTING.md

File metadata and controls

58 lines (41 loc) · 3.02 KB
Raw

How to contribute to the OBO Repository

Thank you for taking the time to contribute. We appreciate it!

There are two ways to contribute to this effort. The first way is to use this project's Issues Page, which we use as a forum to discuss both major and minor issues related to developing the OBO repository, procedures and associated web interface. Examples of the type of issues that can be submitted are:

  • Issues to do with the website and other technical issues
  • Issues relating to metadata about individual ontologies
  • Issues regarding OBO as a whole

Please refer to the FAQ section faq/how-do-i-edit-metadata.md on making Pull Requests.

Issue Resolution

Once a pull request or issue have been submitted, anyone can comment or vote on an issue to express their opinion following the Apache voting system. Quick summary:

  • +1 something you agree with
  • -1 if you have a strong objection to an issue, which will be taken very seriously. A -1 vote should provide an alternative solution.
  • +0 or -0 for neutral comments or weak opinions.
  • It's okay to have input without voting
  • Silence gives assent

A pull request with at least two +1 votes, no -1 votes, and that has been open for at least 3 days, is ready to be merged. The merge should be done by someone from a different organization than the submitter. (We sometimes waive the 3 days for cosmetic-only changes -- use good judgment.)

If an issue gets any -1 votes, the comments on the issue need to reach consensus before the issue can be resolved one way or the other. There isn't any strict time limit on a contentious issue.

The project will strive for full consensus on everything until it runs into a problem with that model.

Python Code Style

All Python code in this repository should conform to black and isort. You can automatically apply them with tox -e lint.

Adding Newsletter Entries

This site uses Jekyll's built-in blog system for newsletters. Take the following steps to get a new post up:

  1. Create a markdown file in the _posts directory. This file name should start with the date of writing in YYYY-MM-DD format, then the remainder of the file name can be a short description of the contents. Use lowercase words and have dashes between them instead of spaces. Example: 2023-06-16-inaugural-newsletter.md.
  2. At the top of the the markdown file, you need the following "frontmatter" (which is YAML hiding between two ---) 
     ---
 layout: post
 categories: newsletter
 title: YOUR TITLE
 author: YOUR NAME
 date: YYYY-MM-DD
 ---
    Where you replace the title and author fields with free text and the date field with a day formatted with YYYY-MM-DD that matches the file name.
  3. Do not begin the newsletter with a title (that uses a # in markdown).
  4. The first paragraph of text in the newsletter will serve as a short description