Skip to content

Latest commit

 

History

History
108 lines (64 loc) · 6.82 KB

CONTRIBUTING.md

File metadata and controls

108 lines (64 loc) · 6.82 KB
Raw

Welcome!

If you are reading this document then you are interested in contributing to ISLE, 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 Slack channel -- #isle -- on islandora.slack.com Feel free to hang out there, ask questions, and help others out if you can.

Workflows

The Islandora ISLE Interest Group meetings are open to everybody on alternating Wednesdays, 3:00pm EDT

  • The meetings are generally held on Zoom (free client), and you can join reading more here

Documentation

  • All documentation for this project can be found within the docs directory.

Request a new feature (use cases).

To request a new feature you should open an issue. You will need a Github account to do this. If you don't have one, you can sign up here. Set the Issue Label to "New Feature".

In order to help us understand the feature request, it would be great if you could provide us with a use case:

Title (Goal) The title or goal of your use case
Primary Actor Repository architect, implementer, repository admin, user
Scope The scope of the project. Example: architecture, access
Level The priority the use case should be given; High, Medium, Low
Story This is a user story.

Examples:

  • Bullet
  • Listed
  • Examples should you want to provide them.

Remarks:

  • Bullet
  • Listed
  • Remarks should you want to provide them.

Report a bug

To report a bug you should open an issue) that summarizes the bug. Set the Issue 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 ISLE and 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.

Participate in a Release

[TO DO] - Project currently not at this phase.

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 ISLE 8 but do not know where to begin:

In this case you should browse open issues.

Contributions to the ISLE 8 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 "New Feature" or "Improvement", 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. ISLE 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.

Developer questions? We have a lot of excellent developer documentation that can be found ... [TO DO]

Issue / Topic Branches

All Github issues should be worked on in separate git branches. The branch name should be the same as the Github issue number, including all-caps, so ISLE-153, ISLE-118, etc.

Example: git checkout -b 7.x-ISLE-977 or git checkout -b 7.x-1.4-ISLE-977

Create a pull request

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

  1. Fork a given ISLE component repository at https://github.com/Islandora-Devops/isle-dc 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 Github 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. ISLE-123: ...). The branch name should also correspond to the Github 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) isle-dc repository.

Community members who have push/merge permissions on a repository should never push directly to a repo, nor merge their own pull requests.

Release branch pull requests

TBD

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.