Skip to content

Contribution Guidelines

Robert Krueger edited this page Oct 12, 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 Story should be opened either at Minerva Story or Minerva Browser. Issues with a packaged version of Minerva Author should be opened either at Minerva Author or Minerva Author UI.

Please mention either in the title or body of your issue whether you are submitting a bug (a problem where an existing feature fails to work as expected) or a feature request (a problem where a needed feature does not exist). Please note the actual behavior of the application when you attempt to trigger the missing behavior. If you are submitting a bug request, also carefully note the steps to reproduce the issue; note whether you have observed the issue multiple times trying one or more methods to reproduce the issue. Please note the version of the Minerva Story or Minerva Author that you are using as well as your operating system and web browser. Please describe the desired behavior of the application. If you are submitting a feature request, please explain why your situation would benefit from the added feature.

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