Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 3.72 KB

CONTRIBUTING.md

File metadata and controls

41 lines (23 loc) · 3.72 KB
Raw

Welcome!

If you are reading this document then you are interested in contributing to Islandora, and that's awesome! 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!

We also have an irc channel -- #islandora -- on freenode.net. Feel free to hang out there, ask questions, and help others out if you can.

Please note that this CONTRIBUTING.md file differs from our standard in the Contribute Code and License Agreements sections because Awesome Islandora is shared on a CC0 Public Domain license and the contribution process has been simplified.

Contribute to the Islandora Cookbook

For most Islandora contributions, you would need to have completed a Contributor License Agreement or be covered by a Corporate Contributor Licencse Agreement. The Islandora Cookbook list is shared on a CC0 Public Domain license, as are all additions. By contributing to the list, your additions will also be shared under this licence. A CLA is not required for contributions to Islandora Awesome.

To contribute to the Islandora Cookbook please ensure your pull request adheres to the guidelines outlined in the README

Create a pull request

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

  1. Fork a given Islandora Foundation component repository at https://github.com/islandora 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 JIRA issue -- for instance, because you reported a bug/issue earlier -- then prefix the title of your pull request with the corresponding issue number (e.g. ISLANDORA-123: ...). The branch name should also correspond to the JIRA issue number.

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.

Community members who have push/merge permissions on a repository should never push directly to a repo.

Merging Pull Requests

In Islandora Labs, the policies for merging may be different from the standard Islandora Committer's Workflow. These policies are set at the discretion of the Current Maintainer, as defined in this project's README.md.

In this project, the following policies apply:

  • The maintainer(s) of this module, and any Islandora Committers, have merge privileges.
  • Merging one's own pull requests is permitted for Islandora Committers.
  • Formal github review is not required, nor is a courtesy waiting period required. Entries should be reviewed for compliance with the Islandora Community Code of Coduct.

License Agreements

Islandora Cookbook is shared on a CC0 Public Domain license, as are all additions. By contributing to the list, your additions will also be shared under this licence. A CLA is not required for contributions to the Islandora Cookbook.