Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
39 lines (27 sloc) 1.88 KB

Contributing to the Ontology Registry and Repository Documentation

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to the documentation of the ORR software (orr-portal, orr-ont). These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

How to contribute?

In general, we intend to follow a Fork and Pull Request workflow.

Feel free to fork the repository, add your changes and give back by issuing a pull request. You can edit the docs directly on your fork at GitHub (not having to ever download the files if you prefer).

You are also very welcome to make any suggestions or report any kind of problem with the documentation by using the ORR documentation issue tracker.

Be aware you may be working on and/or referring to an instance of the ORR derived from a fork of the original ORR code. If your documentation change is only relevant to that particular instance, you may want to leave the documentation changes in your mmiorr-docs fork. But if your changes are general to the ORR system, please do submit a pull request so that the documentation for everyone can be updated.

Who uses these documents? Referencing the ORR

While the examples in the documentation may use the original path in the main ORR instance (at https://mmisw.org), try to refer to the software in a location- and source-independent way (e.g., not "the mmisw.org application" or "MMI's ORR application", but "this ORR application".

[want to contribute a better CONTRIBUTING document? ;)]