Skip to content

Latest commit

 

History

History
68 lines (39 loc) · 6.03 KB

CONTRIBUTING.md

File metadata and controls

68 lines (39 loc) · 6.03 KB
Raw

Welcome!

If you are reading this document then you are interested in contributing to Islandora Vagrant. All contributions are welcome: use-cases, documentation, code, patches, bug reports, feature requests, etc. You do not need to be a programmer to speak up!

Workflows

Islandora Committers Calls happen every Thursday at 2PM EST. The meetings are generally held on Skype, and you can join the calls by sending a request to [email protected].

Use cases

If you would like to submit a use case for the Islandora and Fedora integration project, please submit and issue here using the Use Case template, assign the "use case" label to the issue.

Documentation

You can contribute documentation in two different ways. One way is to create an issue here assign the "documentation" label to the issue. Another way is to by pull request, as same as code contribution.

Request a new feature

To request a new feature you should open an issue or create a use case (see use case section above), and summarize the desired functionality. Select the label "enhancement" if creating an issue on the project repo, and "use case" if creating a use case in the interest group repo.

Report a bug

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

In order to help us understand and fix the bug it would be great 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. The expected behavior.
  3. The actual, incorrect behavior.

Feel free to search the issue queue for existing issues (aka tickets) 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:

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

Contribute code

Before you set out to contribute code you will need to have completed a Contributor License Agreement or be covered by a Corporate Contributor Licencse Agreement. The signed copy of the license agreement should be sent to mailto:[email protected]

If you are interested in contributing code to Islandora but do not know where to begin:

In this case you should browse open issues.

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 small patches, feel free to submit pull requests directly for those patches.

  • For larger code contributions, please use the following process. The idea behind this process is to prevent any wasted work and catch design issues early on.

    1. Open an issue and assign it the label of "enhancement", if a similar issue does not exist already. If a similar issue does exist, then you may 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. Islandora committers 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.

Create a pull request

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

  1. Fork the Islandora GitHub repository at https://github.com/Islandora-Labs/islandora_vagrant to your personal GitHub account. See Fork a repo for detailed instructions.
  2. Commit any changes to your fork.
  3. Send a pull request to the Islandora GitHub repository that you forked in step 1. If your pull request is related to an existing issue -- for instance, because you reported a bug/issue earlier -- prefix the title of your pull request with the corresponding issue number (e.g. issue-123: ...). Please also include a reference to the issue in the description of the pull. This can be done by using '#' plus the issue number like so '#123', also try to pick an appropriate name for the branch in which you're issuing the pull request from.

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 repository.

License Agreements

The Islandora Foundation requires that contributors complete a Contributor License Agreement or be covered by a Corporate Contributor Licencse Agreement. The signed copy of the license agreement should be sent to [email protected]. This license is for your protection as a contributor as well as the protection of the Foundation and its users; it does not change your rights to use your own contributions for any other purpose.