Skip to content

Contribution Guidelines

John Hoffer edited this page Sep 18, 2020 · 4 revisions

Contributing to Minerva

We welcome those wishing to be a part of Minerva development to fork any of the following repositories:

  • Minerva Story

    • for custom deployments of a minerva story website
    • for changes to the template for deploying a minerva story website
  • Minerva Browser

    • for changes to the state and display logic of minerva story
  • Minerva Author

    • for changes to the saving and loading of images and story data
    • for changes to the export of minerva story directories
  • Minerva Author UI

    • for changes to the React app allowing the creation of stories

After you clone your fork to your local computer, create a feature branch with a name relevant to the changes. Once you have made changes that may apply to other users of Minerva, please open a pull request against the master branch of the relevant repository. One of the maintainers of Minerva will review your pull request to ensure it will not pose a breaking change for existing deployments of Minerva.

Reporting issues or problems with the software

If you observe an issue or problem with any aspect of Minerva, please open an issue in the relevant repository. Issues with a deployment of Minerva should be opened either at Minerva Story or Minerva Browser. Issues with the authoring tool should be opened either at Minerva Author or Minerva Author UI.

Seeking support

If you are seeking support for usage of Minerva or are uncertain whether Minerva could work for your particular dataset, please direct an email with your questions to [email protected]. We will either respond with instructions to resolve your situation, or ask you to open an issue in the relevant Github repository to suggest new features be added to Minerva to meet your needs.

Clone this wiki locally