Skip to content

Commit

Permalink
added about and contribute page
Browse files Browse the repository at this point in the history
  • Loading branch information
xavierr committed Jan 25, 2024
1 parent 05f0d1a commit d2c6498
Show file tree
Hide file tree
Showing 3 changed files with 89 additions and 0 deletions.
34 changes: 34 additions & 0 deletions sphinx/about.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
About
=====

Contributors
------------

- Simon Clark, SINTEF, Norway
- Eibar Flores, SINTEF, Norway
- Francesca Lønstad Bleken, SINTEF, Norway
- Jesper Friis, SINTEF, Norway
- Casper Welzel Andersen, SINTEF, Norway
- Martin Uhrin, EPFL, Switzerland
- Simon Stier, Fraunhofer, Germany
- Marek Marcinek, Warsaw University of Technology, Poland
- Anna Szczesna, Warsaw University of Technology, Poland
- Miran Gaberscek, National Institute of Chemistry, Slovenia
- Deyana Stoytcheva, ICMAB, Spain
- Rosa Palacin, ICMAB, Spain
- Ingeborg-Helene Svenum, SINTEF, Norway
- Inga Gudem Ringdalen, SINTEF, Norway
- Emanuele Farhi, SOLEIL synchrotron, France

Projects
--------

- `BIG-MAP <http://www.big-map.eu/>`__; Grant Agreement No: 957189

License
-------

The Battery Interface Domain Ontology is released under the `Creative
Commons Attribution 4.0
International <https://creativecommons.org/licenses/by/4.0/legalcode>`__
license (CC BY 4.0).
53 changes: 53 additions & 0 deletions sphinx/contribute.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
Contributing to the ontology
============================

There are two ways you can contribute to the ontology.

Suggest minor changes on existing elements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`Create a feature
request <https://github.com/emmo-repo/domain-electrochemistry/issues/new>`__
in a `Github
Issue <https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue>`__
to suggest edits to names, defintions, references on existing classes
and properties.

Propose additions/deletion of elements
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**NOTE:** We recommend contacting some of
`BattINFO <https://github.com/BIG-MAP/BattINFO>`__ contributors in
advance to discuss which additions deletions you wish to make.

We recommend using the `forking
workflow <https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow>`__
to contribute additions/deletions. Fork this repository, clone the fork
on your local PC, create your branch based on the existing ``dev``
branch (e.g. ``dev_john_doe``) and work on the editions in you local
copy.

You can edit ontologes in two main ways. One is programmatically, using
for instance `EMMOntoPy <https://github.com/emmo-repo/EMMOntoPy>`__. The
second and more common is using the interface provided by the Protégé
software. In case of the latter, `install
Protégé <https://protege.stanford.edu/>`__ and use it to open the
ontology file you wish to edit. Before adding elements, ensure Prot´égé
is configured to create IRIs in the right format:

- Open Protégé
- Go to File/Open and load the ontology file you wish to modify
- Go to File/Preferences and there go to the New Entities Tab
- Ensure you have configured the preferences as shown below:

| |Protege config.|
| Here is the “Specified IRI” for you to copy:
``https://emmo.info/electrochemistry#``
- Once you have made your changes, commit them to your fork and `create
a pull
request <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request>`__.
- We will merge the request after assessing it.

.. |Protege config.| image:: ../doc/img/protege_config_contribute.png

Check warning on line 52 in sphinx/contribute.rst

View workflow job for this annotation

GitHub Actions / updatepages

image file not readable: ../doc/img/protege_config_contribute.png

Check warning on line 52 in sphinx/contribute.rst

View workflow job for this annotation

GitHub Actions / updatepages

image file not readable: ../doc/img/protege_config_contribute.png

2 changes: 2 additions & 0 deletions sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@
:includehidden:
:hidden:

about
self
electrochemistry
contribute


Electrochemistry Domain Ontology
Expand Down

0 comments on commit d2c6498

Please sign in to comment.