Skip to content

Commit

Permalink
add required info for promotion out of labs
Browse files Browse the repository at this point in the history
  • Loading branch information
Julie Allinson committed Nov 30, 2018
1 parent 51dbbe5 commit 5b5e2d5
Show file tree
Hide file tree
Showing 4 changed files with 118 additions and 25 deletions.
36 changes: 36 additions & 0 deletions CODE_OF_CONDUCT.md
View file
@@ -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/samvera/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/samvera/Samvera+Community+Helpers)
([email](mailto:helpers@samvera.org)), a community member you
trust, or the
[Samvera Steering Group](https://wiki.duraspace.org/display/samvera/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/samvera/Anti-Harassment+Policy)
should be consulted for fuller details.
46 changes: 24 additions & 22 deletions CONTRIBUTING.md
View file
@@ -1,21 +1,24 @@
# 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 the Samvera community 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.

## Code of Conduct

The Hydra 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](https://wiki.duraspace.org/display/hydra/Code+of+Conduct)
for more information.
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.

## 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 Hydra Project Steering Group.
If the contributor works for an institution, the institution must have a Corporate Contributor License Agreement (cCLA) on file.
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/hydra/Hydra+Project+Intellectual+Property+Licensing+and+Ownership
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.

Expand All @@ -31,7 +34,7 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
### Reporting Issues

* Make sure you have a [GitHub account](https://github.com/signup/free)
* Submit a [Github issue](./issues) by:
* Submit a [Github issue](https://github.com/samvera/questioning_authority/issues) by:
* Clearly describing the issue
* Provide a descriptive summary
* Explain the expected behavior
Expand All @@ -48,7 +51,7 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
* 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; est features / UI with Capybara.
* Test functionality with RSpec; Test features / UI with Capybara.
* Run _all_ the tests to assure nothing else was accidentally broken.

### Documenting Code
Expand All @@ -60,15 +63,11 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
* 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
* 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 Down Expand Up @@ -103,6 +102,10 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr
long to fit in 72 characters
```

* Make sure you have added the necessary tests for your changes.
* Run _all_ the tests to assure nothing else was accidentally broken.
* When you are ready to submit a pull request

### Submitting Changes

* Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub.
Expand All @@ -125,9 +128,7 @@ We adopted [Github's Pull Request Review](https://help.github.com/articles/about
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)
2. Approval Required - Github enforces at least one person approve a pull request. Also, all reviewers that have chimed in must approve.

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.

Expand All @@ -144,16 +145,17 @@ First, the person contributing the code is putting themselves out there. Be mind
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:

* Does the commit message explain what is going on?
* Does the code changes have tests? _Not all changes need new tests, some changes are refactors_
* 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 assigning them as a reviewer.

# Additional Resources

* [General GitHub documentation](http://help.github.com/)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
* [GitHub pull request documentation](https://help.github.com/articles/about-pull-requests/)
* [Pro Git](http://git-scm.com/book) is both a free and excellent book about Git.
* [A Git Config for Contributing](http://ndlib.github.io/practices/my-typical-per-project-git-config/)
* [A Git Config for Contributing](http://ndlib.github.io/practices/my-typical-per-project-git-config/)
56 changes: 53 additions & 3 deletions README.md
View file
@@ -1,10 +1,38 @@
# Hyku, the Hydra-in-a-Box Repository Application

Code:
[![Build Status](https://travis-ci.org/samvera-labs/hyku.svg)](https://travis-ci.org/samvera-labs/hyku)
[![Coverage Status](https://coveralls.io/repos/samvera-labs/hyku/badge.svg?branch=master&service=github)](https://coveralls.io/github/samvera-labs/hyku?branch=master)
[![Stories in Ready](https://img.shields.io/waffle/label/samvera-labs/hyku/ready.svg)](https://waffle.io/samvera-labs/hyku)

# Hyku, the Hydra-in-a-Box Repository Application

Product Owner: Hydra-in-a-Box Project (DPLA, DuraSpace, and Stanford University)
Docs:
[![Documentation](http://img.shields.io/badge/DOCUMENTATION-wiki-blue.svg)](https://github.com/samvera-labs/hyku/wiki)
[![Contribution Guidelines](http://img.shields.io/badge/CONTRIBUTING-Guidelines-blue.svg)](./CONTRIBUTING.md)
[![Apache 2.0 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)

Jump In: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/)

----
## Table of Contents

* [Running the stack](#running-the-stack)
* [For development](#for-development)
* [For testing](#for-testing)
* [On AWS](#on-aws)
* [With Docker](#with-docker)
* [With Vagrant](#with-vagrant)
* [Switching accounts](#switching-accounts)
* [Development dependencies](#development-dependencies)
* [Postgres](#postgres)
* [Importing](#importing)
* [from CSV](#from-csv)
* [from purl](#from-purl)
* [Compatibility](#compatibility)
* [Product Owner](#product-owner)
* [Help](#help)
* [Acknowledgments](#acknowledgments)

----

## Running the stack

Expand Down Expand Up @@ -75,3 +103,25 @@ Hydra-in-a-Box supports multitenancy using the `apartment` gem. `apartment` work
```bash
./bin/import_from_purl ../hyku-objects bc390xk2647 bc402fk6835 bc483gc9313
```

## Compatibility

* Ruby 2.4 or the latest 2.3 version is recommended. Later versions may also work.
* Rails 5 is required. We recommend the latest Rails 5.1 release.

### Product Owner

[orangewolf](https://github.com/orangewolf)

## Help

The Samvera community is here to help. Please see our [support guide](./SUPPORT.md).

## Acknowledgments

This software was developed by the Hydra-in-a-Box Project (DPLA, DuraSpace, and Stanford University) under a grant from IMLS.

This software is brought to you by the Samvera community. Learn more at the
[Samvera website](http://samvera.org/).

![Samvera Logo](https://wiki.duraspace.org/download/thumbnails/87459292/samvera-fall-font2-200w.png?version=1&modificationDate=1498550535816&api=v2)
5 changes: 5 additions & 0 deletions SUPPORT.md
View file
@@ -0,0 +1,5 @@
If you would like to report an issue, first search [the list of issues](https://github.com/samvera/questioning_authority/issues/) to see if someone else has already reported it, and then feel free to [create a new issue](https://github.com/samvera/questioning_authority/issues/new).

If you have questions or need help, please email [the Samvera community tech list](https://groups.google.com/forum/#!forum/samvera-tech) or stop by the #dev channel in [the Samvera community Slack team](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391#Getintouch!-Slack).

You can learn more about the various Samvera communication channels on the [Get in touch!](https://wiki.duraspace.org/pages/viewpage.action?pageId=87460391) wiki page.

0 comments on commit 5b5e2d5

Please sign in to comment.