Skip to content

Commit

Permalink
Merge pull request #442 from samvera/backports_for_10.5.1
Browse files Browse the repository at this point in the history
Backports for 10.5.1
  • Loading branch information
cjcolvar authored Apr 9, 2018
2 parents 1a0d0ee + ce0e589 commit 8fe1750
Show file tree
Hide file tree
Showing 8 changed files with 121 additions and 184 deletions.
36 changes: 36 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
The Samvera community is dedicated to providing a welcoming and
positive experience for all its members, whether they are at a formal
gathering, in a social setting, or taking part in activities online.
The Samvera community welcomes participation from people all over the
world and these members bring with them a wide variety of
professional, personal and social backgrounds; whatever these may be,
we treat colleagues with dignity and respect.

Community members communicate primarily in English, though for many of
them this is not their native language. We therefore strive to express
ourselves simply and clearly remembering that unnecessary use of
jargon and slang will be a barrier to understanding for many of our
colleagues. We are sensitive to the fact that the international
nature of the community means that we span many different social norms
around language and behaviour and we strive to conduct ourselves,
online and in person, in ways that are unlikely to cause offence.

Samvera conversations are often information-rich and intended to
generate discussion and debate. We discuss ideas from a standpoint of
mutual respect and reasoned argument.

Community members work together to promote a respectful and safe
community. In the event that someone’s conduct is causing offence or
distress, Samvera has a detailed
[Anti-Harassment Policy and Protocol](https://wiki.duraspace.org/display/hydra/Anti-Harassment+Policy)
which can be applied to address the problem. The first step in dealing
with any serious misconduct is to contact a local meeting organizer,
the
[Samvera community helpers](https://wiki.duraspace.org/display/hydra/Hydra+Community+Helpers)
([email](mailto:[email protected])), a community member you
trust, or the
[Samvera Steering Group](https://wiki.duraspace.org/display/hydra/Samvera+Steering+Group+membership)
immediately; at Samvera events, these people can be identified by
distinctive name badges. The
[Policy and Protocol](https://wiki.duraspace.org/display/hydra/Anti-Harassment+Policy)
should be consulted for fuller details.
92 changes: 74 additions & 18 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,35 @@
# How to Contribute

We want your help to make Project Hydra great.
There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.
We want your help to make Samvera great. There are a few guidelines
that we need contributors to follow so that we can have a chance of
keeping on top of things.

## Hydra Project Intellectual Property Licensing and Ownership
## Code of Conduct

All code contributors must have an Individual Contributor License Agreement (iCLA) on file with the Hydra Project Steering Group.
If the contributor works for an institution, the institution must have a Corporate Contributor License Agreement (cCLA) on file.
The Samvera Community is dedicated to providing a welcoming and positive
experience for all its members, whether they are at a formal gathering, in
a social setting, or taking part in activities online. Please see our
[Code of Conduct](CODE_OF_CONDUCT.md) for more information.

https://wiki.duraspace.org/display/hydra/Hydra+Project+Intellectual+Property+Licensing+and+Ownership
## Samvera Community Intellectual Property Licensing and Ownership

All code contributors must have an Individual Contributor License Agreement
(iCLA) on file with the Samvera Steering Group. If the contributor works for
an institution, the institution must have a Corporate Contributor License
Agreement (cCLA) on file.

https://wiki.duraspace.org/display/samvera/Samvera+Community+Intellectual+Property+Licensing+and+Ownership

You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project.

## Contribution Tasks

* Reporting Issues
* Making Changes
* Documenting Code
* Committing Changes
* Submitting Changes
* Merging Changes
* Reviewing and Merging Changes

### Reporting Issues

Expand All @@ -38,8 +50,28 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
* Then checkout the new branch with `git checkout fix/master/my_contribution`.
* Please avoid working directly on the `master` branch.
* You may find the [hub suite of commands](https://github.com/defunkt/hub) helpful
* Make sure you have added sufficient tests and documentation for your changes.
* Test functionality with RSpec; Test features / UI with Capybara.
* Run _all_ the tests to assure nothing else was accidentally broken.

### Documenting Code

* All new public methods, modules, and classes should include inline documentation in [YARD](http://yardoc.org/).
* Documentation should seek to answer the question "why does this code exist?"
* Document private / protected methods as desired.
* If you are working in a file with no prior documentation, do try to document as you gain understanding of the code.
* If you don't know exactly what a bit of code does, it is extra likely that it needs to be documented. Take a stab at it and ask for feedback in your pull request. You can use the 'blame' button on GitHub to identify the original developer of the code and @mention them in your comment.
* This work greatly increases the usability of the code base and supports the on-ramping of new committers.
* We will all be understanding of one another's time constraints in this area.
* YARD examples:
* [Hydra::Works::RemoveGenericFile](https://github.com/projecthydra-labs/hydra-works/blob/master/lib/hydra/works/services/generic_work/remove_generic_file.rb)
* [ActiveTriples::LocalName::Minter](https://github.com/ActiveTriples/active_triples-local_name/blob/master/lib/active_triples/local_name/minter.rb)
* [Getting started with YARD](http://www.rubydoc.info/gems/yard/file/docs/GettingStarted.md)

### Committing changes

* Make commits of logical units.
* Your commit should include a high level description of your work in HISTORY.textile
* Your commit should include a high level description of your work in HISTORY.textile
* Check for unnecessary whitespace with `git diff --check` before committing.
* Make sure your commit messages are [well formed](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
* If you created an issue, you can close it by including "Closes #issue" in your commit message. See [Github's blog post for more details](https://github.com/blog/1386-closing-issues-via-commit-messages)
Expand All @@ -60,7 +92,9 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
class PostsController
def index
respond_with Post.limit(10)
respond_to do |wants|
wants.html { render 'index' }
end
end
end
Expand All @@ -86,24 +120,46 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
* `git pull --rebase`
* `git checkout <your-branch>`
* `git rebase master`
* It is likely a good idea to run your tests again.
* Squash the commits for your branch into one commit
* `git rebase --interactive HEAD~<number-of-commits>` ([See Github help](https://help.github.com/articles/interactive-rebase))
* To determine the number of commits on your branch: `git log master..<your-branch> --oneline | wc -l`
* It is a good idea to run your tests again.
* If you've made more than one commit take a moment to consider whether squashing commits together would help improve their logical grouping.
* [Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/)
* `git rebase --interactive master` ([See Github help](https://help.github.com/articles/interactive-rebase))
* Squashing your branch's changes into one commit is "good form" and helps the person merging your request to see everything that is going on.
* Push your changes to a topic branch in your fork of the repository.
* Submit a pull request from your fork to the project.

### Merging Changes
### Reviewing and Merging Changes

We adopted [Github's Pull Request Review](https://help.github.com/articles/about-pull-request-reviews/) for our repositories.
Common checks that may occur in our repositories:

1. Travis CI - where our automated tests are running
2. Hound CI - where we check for style violations
3. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.
4. CodeClimate - is our code remaining healthy (at least according to static code analysis)

If one or more of the required checks failed (or are incomplete), the code should not be merged (and the UI will not allow it). If all of the checks have passed, then anyone on the project (including the pull request submitter) may merge the code.

*Example: Carolyn submits a pull request, Justin reviews the pull request and approves. However, Justin is still waiting on other checks (Travis CI is usually the culprit), so he does not merge the pull request. Eventually, all of the checks pass. At this point, Carolyn or anyone else may merge the pull request.*

#### Things to Consider When Reviewing

First, the person contributing the code is putting themselves out there. Be mindful of what you say in a review.

* Ask clarifying questions
* State your understanding and expectations
* Provide example code or alternate solutions, and explain why

This is your chance for a mentoring moment of another developer. Take time to give an honest and thorough review of what has changed. Things to consider:

* It is considered "poor from" to merge your own request.
* Please take the time to review the changes and get a sense of what is being changed. Things to consider:
* Does the commit message explain what is going on?
* Does the code changes have tests? _Not all changes need new tests, some changes are refactorings_
* Do new or changed methods, modules, and classes have documentation?
* Does the commit contain more than it should? Are two separate concerns being addressed in one commit?
* Does the description of the new/changed specs match your understanding of what the spec is doing?
* Did the Travis tests complete successfully?
* If you are uncertain, bring other contributors into the conversation by creating a comment that includes their @username.
* If you like the pull request, but want others to chime in, create a +1 comment and tag a user.

If you are uncertain, bring other contributors into the conversation by assigning them as a reviewer.

# Additional Resources

Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Changes proposed in this pull request:
*
*

@projecthydra/hydra-contributors
@samvera/hydra-head
3 changes: 3 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
If you would like to report an issue with Hydra-Head, first search [the list of issues](https://github.com/samvera/hydra-head/issues/) to see if someone else has already reported it, and then feel free to [create a new issue](https://github.com/samvera/hydra-head/issues/new).

If you have questions or need help, please email [the Samvera community tech list](mailto:[email protected]) or stop by the #dev channel in [the Samvera community Slack team](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391#Getintouch!-Slack).
10 changes: 5 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
language: ruby
sudo: false
rvm: 2.4.2
rvm: 2.5.1

matrix:
include:
- env: "RAILS_VERION=5.1.4"
- rvm: 2.3.5
env: "BLACKLIGHT_VERSION=5.17.2 RAILS_VERSION=5.0.6"
- env: "RAILS_VERSION=5.1.6"
- rvm: 2.4.3
env: "BLACKLIGHT_VERSION=5.19.2 RAILS_VERSION=5.0.7"

env:
global:
- NOKOGIRI_USE_SYSTEM_LIBRARIES=true
- BLACKLIGHT_VERSION=6.12.0
- BLACKLIGHT_VERSION=6.14.1
before_install:
- gem update --system

Expand Down
159 changes: 0 additions & 159 deletions CONTRIBUTING.md

This file was deleted.

Loading

0 comments on commit 8fe1750

Please sign in to comment.