Skip to content
This repository has been archived by the owner on Jan 23, 2024. It is now read-only.

Latest commit

 

History

History
78 lines (47 loc) · 5.6 KB

CONTRIBUTING.md

File metadata and controls

78 lines (47 loc) · 5.6 KB
Raw

Contributing to Islandora Web Annotations Utility Module

All contributions to Islandora Web Annotations Utility Module are welcome: use-cases, documentation, code, bug reports, feature requests, etc. You do not need to be a programmer to contribute!

Regardless of how you want to contribute to Islandora Web Annotations Utility Module, start by opening a Github issue. Someone (probably one of the maintainers) will respond and keep the discussion going.

Write some documentation

If you use Islandora Web Annotations Utility Module and you have documented a task for yourself, consider sharing it with other users. We'd be happy to put it on the Islandora Web Annotations Utility Module wiki or link to it if you'd rather maintain it somewhere else.

Request a new feature

We love hear about how you want to use Islandora Web Annotations Utility Module! In order to help us understand a new feature request, we ask you to provide us with a structured use case following this template:

Title (Goal) The title or goal of your use case
Primary Actor Repository architect, metadata specialist, repository admin
Scope The scope of the feature. Example: usability, performance
Level The priority the use case should be given; High, Medium, Low
Story A paragraph of text describing how this feature should work a what it should accomplish

Additional examples:

  • One per list bullet

Additional Remarks:

  • One per list bullet

Report a bug

To report a bug you should open an issue that summarizes the bug. Set the Issue Type to "Bug".

In order to help us understand and fix the bug it would be useful if you could provide us with:

  1. The steps to reproduce the bug. This includes information about e.g. the Islandora version you were using along with version of stack components.
  2. If applicable, some sample data that triggers the bug.
  3. The expected behavior.
  4. The current, incorrect behavior.

Feel free to search the issue queue for existing issues that already describe the problem; if there is such a ticket please add your information as a comment.

If you want to provide a pull along with your bug report:

In this case please send us a pull request as described in section Create a pull request below.

Contribute code

Contributions to the Islandora codebase should be sent as GitHub pull requests. See section Create a pull request below for details. If there is any problem with the pull request we can work through it using the commenting features of GitHub.

  • For all code contributions, please use the following process in order to to prevent any wasted work and catch design issues early on.

    1. Open an issue and assign it the label of "enhancement" or "feature request", if a similar issue does not exist already. If a similar issue does exist, then you should consider participating in the work on the existing issue.
    2. Comment on the issue with your plan for implementing the issue. Explain what pieces of the codebase you are going to touch and how everything is going to fit together.
    3. The Islandora Web Annotations Utility Module maintainers will work with you on the design to make sure you are on the right track.
    4. Implement your issue, create a pull request (see below), and iterate from there.

Issue / Topic Branches

All issues should be worked on in separate git branches. The branch name should be the same as the Github issue number, e.g., issue-243.

Create a pull request

Take a look at Creating a pull request. In a nutshell you need to:

  1. Fork the Islandora Web Annotations Utility Module repository to your personal GitHub account. See Fork a repo for detailed instructions.
  2. Commit any changes to the issue/topic branch in your fork. Comments can be as terse as "Work on #243.", etc. but you can be more descriptive if you want. However, please refer to the issue you are working on somewhere in the commit comment using Github's '#' shortcut, as in the example.
  3. Send a pull request to the Islandora Web Annotations Utility Module GitHub repository that you forked in step 1 (in other words, https://github.com/digitalutsc/islandora_web_annotations).

You may want to read Syncing a fork for instructions on how to keep your fork up to date with the latest changes of the upstream (official) Islandora Web Annotations Utility Module repository.

License Agreements

Islandora Web Annotations Utility Module is licensed under GPL version 3 or higher. By opening a pull request or otherwise contributing code to the Islandora Web Annotations Utility Module codebase, you transfer non-exclusive ownership of that code (you retain ownership of your code for other purposes) to the Islandora Web Annotations Utility Module maintainers for the sole purpose of redistributing your contribution within the Islandora Web Annotations Utility Module codebase under the conditions of the GPLv3 license or higher. You also warrant that you have the legal authority to make such a transfer.

Thanks

This CONTRIBUTING.md file is based heavily on the CONTRIBUTING.md file included with Islandora Foundation modules and the Move to Islandora Kit.