From db8e376d928c3c9db8653eb7066223251bc63056 Mon Sep 17 00:00:00 2001 From: Noah Botimer Date: Tue, 14 Aug 2018 17:54:28 -0400 Subject: [PATCH] Update docs to match templates Resolve #156; Link to contribution guidelines --- CONTRIBUTING.md | 14 +++----------- README.md | 37 ++++++++++++++++++++++++++++++++++--- SUPPORT.md | 6 ++++++ 3 files changed, 43 insertions(+), 14 deletions(-) create mode 100644 SUPPORT.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 10c95c4..df6e14d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # How to Contribute -We want your help to make Samvera great. There are a few guidelines +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. @@ -63,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::UploadFileToFileSet](https://github.com/samvera/hydra-works/blob/master/lib/hydra/works/services/upload_file_to_file_set.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) @@ -112,8 +108,6 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr ### Submitting Changes -[Detailed Walkthrough of One Pull Request per Commit](http://ndlib.github.io/practices/one-commit-per-pull-request/) - * Read the article ["Using Pull Requests"](https://help.github.com/articles/using-pull-requests) on GitHub. * Make sure your branch is up to date with its parent branch (i.e. master) * `git checkout master` @@ -134,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. @@ -164,6 +156,6 @@ If you are uncertain, bring other contributors into the conversation by assignin # 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/) diff --git a/README.md b/README.md index f931e75..1f1cfbe 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,36 @@ -# HydraEditor [![Gem Version](https://badge.fury.io/rb/hydra-editor.png)](http://badge.fury.io/rb/hydra-editor) [![Build Status](https://travis-ci.org/samvera/hydra-editor.png)](https://travis-ci.org/samvera/hydra-editor) +# HydraEditor + +Code: +[![Gem Version](https://badge.fury.io/rb/hydra-editor.png)](http://badge.fury.io/rb/hydra-editor) +[![Build Status](https://travis-ci.org/samvera/hydra-editor.png)](https://travis-ci.org/samvera/hydra-editor) [![Coverage Status](https://coveralls.io/repos/github/samvera/hydra-editor/badge.svg?branch=master)](https://coveralls.io/github/samvera/hydra-editor?branch=master) +Docs: +[![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.txt) + +Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/) + +# What is hydra-editor? + +A basic metadata editor for Rails applications based on hydra-head. + +## Product Owner & Maintenance + +**hydra-editor** is a Core Component of the Samvera community. The documentation for +what this means can be found +[here](http://samvera.github.io/core_components.html#requirements-for-a-core-component). + +### Product Owner + +[jrgriffiniii](https://github.com/jrgriffiniii) + +# Help + +The Samvera community is here to help. Please see our [support guide](./SUPPORT.md). + +# Getting Started + To use add to your gemfile: ```ruby @@ -126,8 +156,9 @@ end If you are not mounting the engine or using its default routes, you can include RecordsControllerBehavior in your own controller and add the appropriate routes to your app's config/routes.rb. -# Samvera +# Acknowledgments + This software has been developed by and is brought to you by the Samvera community. Learn more at the -[Samvera website](https://samvera.org/) +[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) diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..c023cdd --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,6 @@ +If you would like to report an issue, first search [the list of issues](https://github.com/samvera/hydra-editor/issues/) to see if someone else has already reported it, and then feel free to [create a new issue](https://github.com/samvera/hydra-editor/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. +