diff --git a/.prettierignore b/.prettierignore index 42061c0..b43bf86 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1 +1 @@ -README.md \ No newline at end of file +README.md diff --git a/.prettierrc.yml b/.prettierrc.yml new file mode 100644 index 0000000..787ed73 --- /dev/null +++ b/.prettierrc.yml @@ -0,0 +1,5 @@ +printWidth: 80 +overrides: + - files: "samvera-circleci-orb/**/*yml" + options: + printWidth: 80 diff --git a/README.md b/README.md index 30f6aa8..bdf302f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,41 @@ This repository holds templates and guidelines to support the maintenance of projects in the [Samvera](https://github.com/samvera) Github organization. -## Samvera Core Components +## Samvera GitHub Organization + +The Samvera GitHub Organization (https://github.com/samvera/) contains `git` repositories for multiple projects developed and actively maintained by the Samvera Community. The projects themselves may be divided into four distinct groups: + +- Hyrax +- Samvera Ruby Gems +- Samvera JavaScript Packages +- Samvera Infrastructure +- Samvera Administration + +### Hyrax +_(and the Hyrax Ecosystem)_ + +Hyrax stands as an open source, self-deposit repository project, which has been actively maintained and under continuous development for approximately seven years. GitHub repositories exist for Samvera which actively maintain not only the [Hyrax source code base](https://github.com/samvera/hyrax), but which provide [a framework for deploying Hyrax implementations using virtualized server or cloud infrastructure](https://github.com/samvera/hyku), along with other projects supporting Hyrax infrastructure. + +### Samvera Ruby Gems +_(formerly labeled as "Core Components")_ + +Samvera Ruby Gems are published as small, modular software libraries which were designed to be adopted by [Ruby on Rails](https://rubyonrails.org/) application developers who seek to implement digital object repositories. Core Components permit developers to benefit from, and contribute to Samvera for cases in which Hyrax might be impractical or unsatisfactory for their organizational requirements. + +### Samvera JavaScript Packages + +While Hyrax and Samvera Ruby Gems provide a suite of solutions for web application developers seeking to implement digital object repositories, there exist a small, but growing number of projects which exclusively provide user interface features and functionality. These are expected to provide published JavaScript packages using the [npm](https://npmjs.com), and, being under the open source Apache 2.0 license, are most welcome for contributors. + +### Samvera Infrastructure + +There also exist those Samvera Community projects which provide some hosted service which integrates into a digital object repository ecosystem, but which does not provide any enhanced user interface (or, which are not intended for usage by humans). Within this category fall serverless functions, microservices, configuration management templates, and virtualization utilities. + +### Samvera Administration + +Projects categorized for Samvera Administration typically provide some function related to community management (such as [this repository](https://github.com/samvera/maintenance)), [static websites](https://github.com/samvera/samvera.github.io), or other forms of documentation. + +## Maintenance Requirements + +There are explicitly stated guidelines for maintaining projects within the Samvera Organization: Samvera Core Components are defined as the following: @@ -10,37 +44,87 @@ Samvera Core Components are defined as the following: _Please reference [A Guide for the Samvera Community](https://samvera.github.io/core_components.html) for further information._ -Currently, there are twenty Samvera Core Components maintained by the community: - -### Ruby Samvera Components - -| Component | CircleCI Status | Ruby 3.1 Support | Ruby 3.0 Support | Ruby 2.7 Support | Ruby 2.6 Support | Rails 7.0 Support | Rails 6.1 Support | Rails 6.0 Support | Rails 5.2 Support | -| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | -| [active_fedora](https://github.com/samvera/active_fedora) | [![Build Status](https://circleci.com/gh/samvera/active_fedora.svg?style=svg)](https://circleci.com/gh/samvera/active_fedora) | | | 2.7.0 | 2.6.5 | | | 6.0.2 | 5.2.4 | -| [bixby](https://github.com/samvera/bixby) | [![Build Status](https://circleci.com/gh/samvera/bixby.svg?style=svg)](https://circleci.com/gh/samvera/bixby) | 3.1.1 | 3.0.3 | 2.7.5 | 2.6.9 | N/A | N/A | N/A | N/A | -| [browse-everything](https://github.com/samvera/browse-everything) | [![Build Status](https://circleci.com/gh/samvera/browse-everything.svg?style=svg)](https://circleci.com/gh/samvera/browse-everything) | | | 2.7.5 | 2.6.9 | | | 6.0.4.7 | 5.2.4 | -| [hydra-derivatives](https://github.com/samvera/hydra-derivatives) | [![Build Status](https://circleci.com/gh/samvera/hydra-derivatives.svg?style=svg)](https://circleci.com/gh/samvera/hydra-derivatives) | | | 2.7.5 | 2.6.9 | N/A | N/A | N/A | N/A | -| [hydra-editor](https://github.com/samvera/hydra-editor) | [![Build Status](https://circleci.com/gh/samvera/hydra-editor.svg?style=svg)](https://circleci.com/gh/samvera/hydra-editor) | | | 2.7.5 | 2.6.9 | | | 6.0.3.4 | 5.2.3 | -| [hydra-file_characterization](https://github.com/samvera/hydra-file_characterization) | [![Build Status](https://circleci.com/gh/samvera/hydra-file_characterization.svg?style=svg)](https://circleci.com/gh/samvera/hydra-file_characterization) | | 3.0.3 | 2.7.5 | 2.6.9 | 7.0.2.3 | 6.1.5 | 6.0.4.7 | 5.2.7 | -| [hydra-head](https://github.com/samvera/hydra-head) | [![Build Status](https://circleci.com/gh/samvera/hydra-head.svg?style=svg)](https://circleci.com/gh/samvera/hydra-head) | | | 2.7.3 | 2.6.7 | | | 6.0.3.7 | 5.2.6 | -| [hydra-pcdm](https://github.com/samvera/hydra-pcdm) | [![Build Status](https://circleci.com/gh/samvera/hydra-pcdm.svg?style=svg)](https://circleci.com/gh/samvera/hydra-pcdm) | | | 2.7.5 | 2.6.9 | | | 6.0.2 | 5.2.4 | -| [hydra-role-management](https://github.com/samvera/hydra-role-management) | [![Build Status](https://circleci.com/gh/samvera/hydra-role-management.svg?style=svg)](https://circleci.com/gh/samvera/hydra-role-management) | | | 2.7.5 | 2.6.9 | | | 6.0.2 | 5.2.4 | -| [hydra-works](https://github.com/samvera/hydra-works) | [![Build Status](https://circleci.com/gh/samvera/hydra-works.svg?style=svg)](https://circleci.com/gh/samvera/hydra-works) | | | 2.7.5 | 2.6.9 | | | 6.0.3.1 | 5.2.4.3 | [![Build Status](https://circleci.com/gh/samvera/hydra-works.svg?style=svg)](https://circleci.com/gh/samvera/hydra-works) | -| [iiif_manifest](https://github.com/samvera/iiif_manifest) | [![Build Status](https://circleci.com/gh/samvera/iiif_manifest.svg?style=svg)](https://circleci.com/gh/samvera/iiif_manifest) | | 3.0.3 | 2.7.5 | 2.6.9 | N/A | N/A | N/A | N/A | -| [ldp](https://github.com/samvera/ldp) | [![Build Status](https://circleci.com/gh/samvera/ldp.svg?style=svg)](https://circleci.com/gh/samvera/ldp) | | | 2.7.5 | 2.6.9 | | | 6.0.4.4 | 5.2.0 | -| [noid-rails](https://github.com/samvera/noid-rails) | [![Build Status](https://circleci.com/gh/samvera/noid-rails.svg?style=svg)](https://circleci.com/gh/samvera/noid-rails) | | | 2.7.5 | 2.6.9 | | 6.1.3.2 | 6.0.3.2 | 5.2.4.3 | -| [questioning_authority](https://github.com/samvera/questioning_authority) | [![Build Status](https://circleci.com/gh/samvera/questioning_authority.svg?style=svg)](https://circleci.com/gh/samvera/questioning_authority) | | | 2.7.5 | 2.6.9 | | 6.1.1 | 6.0.2 | 5.2.4 | -| [rubydora](https://github.com/samvera/rubydora) | [![Build Status](https://circleci.com/gh/samvera/rubydora.svg?style=svg)](https://circleci.com/gh/samvera/rubydora) | | | 2.7.5 | 2.6.9 | | | 6.0.2 | 5.2.4 | -| [samvera.github.io](https://github.com/samvera/samvera.github.io) | [![Build Status](https://circleci.com/gh/samvera/samvera.github.io.svg?style=svg)](https://circleci.com/gh/samvera/samvera.github.io) | 3.1.1 | 3.0.3 | 2.7.5 | 2.6.9 | N/A | N/A | N/A | N/A | -| [samvera-circleci-orb](https://github.com/samvera/samvera-circleci-orb) | [![Build Status](https://circleci.com/gh/samvera/samvera-circleci-orb.svg?style=svg)](https://circleci.com/gh/samvera/samvera-circleci-orb) | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | -| [valkyrie](https://github.com/samvera/valkyrie) | [![Build Status](https://circleci.com/gh/samvera/valkyrie.svg?style=svg)](https://circleci.com/gh/samvera/valkyrie) | | | 2.7.5 | 2.6.5 | | | 6.0.5 | 5.2.8 | - -### JavaScript Samvera Components - -| Component | CircleCI Status | Node.js 18.x Support | Node.js 16.x Support | Node.js 14.x Support | -| ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------- | -------------------- | -------------------- | -| [node-iiif](https://github.com/samvera/node-iiif) | [![Build Status](https://circleci.com/gh/samvera/node-iiif.svg?style=svg)](https://circleci.com/gh/samvera/node-iiif) | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | -| [serverless-iiif](https://github.com/samvera/serverless-iiif) | [![Build Status](https://circleci.com/gh/samvera/serverless-iiif.svg?style=svg)](https://circleci.com/gh/samvera/serverless-iiif) | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | +### Hyrax Ecosystem +| Project | CircleCI Status | +| --- | --- | +|[hyrax](https://github.com/samvera/hyrax)|[![Build Status](https://circleci.com/gh/samvera/hyrax.svg?style=svg)](https://circleci.com/gh/samvera/hyrax)| +|[hyku](https://github.com/samvera/hyku)|[![Build Status](https://circleci.com/gh/samvera/hyku.svg?style=svg)](https://circleci.com/gh/samvera/hyku)| +|[nurax](https://github.com/samvera/nurax)|[![Build Status](https://circleci.com/gh/samvera/nurax.svg?style=svg)](https://circleci.com/gh/samvera/nurax)| + +### Samvera Ruby Gems + +| Gem | CircleCI Status | Ruby 3.2 Support | Ruby 3.1 Support | Ruby 3.0 Support | Ruby 2.7 Support | Rails 7.0 Support | Rails 6.1 Support | Rails 6.0 Support | +| --- | --- | --- | --- | --- | --- | --- | --- | --- | +|[hydra-derivatives](https://github.com/samvera/hydra-derivatives)|[![Build Status](https://circleci.com/gh/samvera/hydra-derivatives.svg?style=svg)](https://circleci.com/gh/samvera/hydra-derivatives)|✅|✅|✅|✅||||| +|[iiif_manifest](https://github.com/samvera/iiif_manifest)|[![Build Status](https://circleci.com/gh/samvera/iiif_manifest.svg?style=svg)](https://circleci.com/gh/samvera/iiif_manifest)|✅|✅|✅|✅||||| +|[ldp](https://github.com/samvera/ldp)|[![Build Status](https://circleci.com/gh/samvera/ldp.svg?style=svg)](https://circleci.com/gh/samvera/ldp)|✅|✅|✅|✅|✅|✅|✅|✅| +|[valkyrie](https://github.com/samvera/valkyrie)|[![Build Status](https://circleci.com/gh/samvera/valkyrie.svg?style=svg)](https://circleci.com/gh/samvera/valkyrie)|✅|✅|✅|✅|✅|✅|✅|✅| + +#### Under Reorganization +![under reorganization](https://img.shields.io/badge/under-reorg-yellow) + +_The following Gems are being merged into other GitHub repositories, but shall remain in active maintenance and released as Gems._ + +|Gem |CircleCI Status|Ruby 3.2 Support|Ruby 3.1 Support|Ruby 3.0 Support|Ruby 2.7 Support|Rails 7.0 Support|Rails 6.1 Support|Rails 6.0 Support| +| --- | --- | --- | --- | --- | --- | --- | --- | --- | +|[active_fedora](https://github.com/samvera/active_fedora)|[![Build Status](https://circleci.com/gh/samvera/active_fedora.svg?style=svg)](https://circleci.com/gh/samvera/active_fedora)|✅|✅|✅|✅|✅|✅|✅|✅| +|[bixby](https://github.com/samvera/bixby)|[![Build Status](https://circleci.com/gh/samvera/bixby.svg?style=svg)](https://circleci.com/gh/samvera/bixby)|✅|✅|✅|✅||||| +|[hydra-editor](https://github.com/samvera/hydra-editor)|[![Build Status](https://circleci.com/gh/samvera/hydra-editor.svg?style=svg)](https://circleci.com/gh/samvera/hydra-editor)|✅|✅|✅|✅|✅|✅|✅|✅| +|[hydra-file_characterization](https://github.com/samvera/hydra-file_characterization)|[![Build Status](https://circleci.com/gh/samvera/hydra-file_characterization.svg?style=svg)](https://circleci.com/gh/samvera/hydra-file_characterization)|✅|✅|✅|✅|✅|✅|✅|✅| +|[hydra-head](https://github.com/samvera/hydra-head)|[![Build Status](https://circleci.com/gh/samvera/hydra-head.svg?style=svg)](https://circleci.com/gh/samvera/hydra-head)|✅|✅|✅|✅|✅|✅|✅|✅| +|[hydra-pcdm](https://github.com/samvera/hydra-pcdm)|[![Build Status](https://circleci.com/gh/samvera/hydra-pcdm.svg?style=svg)](https://circleci.com/gh/samvera/hydra-pcdm)|✅|✅|✅|✅|✅|✅|✅|✅| +|[hydra-role-management](https://github.com/samvera/hydra-role-management)|[![Build Status](https://circleci.com/gh/samvera/hydra-role-management.svg?style=svg)](https://circleci.com/gh/samvera/hydra-role-management)|✅|✅|✅|✅|✅|✅|✅|✅| +|[hydra-works](https://github.com/samvera/hydra-works)|[![Build Status](https://circleci.com/gh/samvera/hydra-works.svg?style=svg)](https://circleci.com/gh/samvera/hydra-works)|✅|✅|✅|✅|✅|✅|✅|✅| +|[noid-rails](https://github.com/samvera/noid-rails)|[![Build Status](https://circleci.com/gh/samvera/noid-rails.svg?style=svg)](https://circleci.com/gh/samvera/noid-rails)|✅|✅|✅|✅|✅|✅|✅|✅| +|[samvera.github.io](https://github.com/samvera/samvera.github.io)|[![Build Status](https://circleci.com/gh/samvera/samvera.github.io.svg?style=svg)](https://circleci.com/gh/samvera/samvera.github.io)|❌|✅|✅|✅||||| + +#### Awaiting Promotion +![awaiting promotion](https://img.shields.io/badge/awaiting-promotion-blue) + +_The following Gems must be promoted from the [Samvera Labs](https://github.com/samvera-labs) in order to support the ongoing maintenance of [Samvera](https://github.com/samvera) Gems._ + +|Gem |CircleCI Status|Ruby 3.2 Support|Ruby 3.1 Support|Ruby 3.0 Support|Ruby 2.7 Support|Rails 7.0 Support|Rails 6.1 Support|Rails 6.0 Support| +| --- | --- | --- | --- | --- | --- | --- | --- | --- | +|[ActiveTriples](https://github.com/samvera-labs/ActiveTriples)|[![Build Status](https://circleci.com/gh/samvera-labs/ActiveTriples.svg?style=svg)](https://circleci.com/gh/samvera-labs/ActiveTriples)|❌|❌|❌|❌||||| +|[engine_cart](https://github.com/cbeer/engine_cart)|[![Build Status](https://github.com/cbeer/engine_cart/workflows/CI/badge.svg)](https://github.com/cbeer/engine_cart/actions)|✅|✅|✅|✅|✅|✅|✅|✅| +|[huborg](https://github.com/samvera-labs/huborg)|||||||||| +|[ldpath](https://github.com/samvera-labs/ldpath)|[![Build Status](https://circleci.com/gh/samvera-labs/ldpath.svg?style=svg)](https://circleci.com/gh/samvera-labs/ldpath)|❌|✅|✅|✅||||| +|[samvera-labs.github.io](https://github.com/samvera-labs/samvera-labs.github.io)|||||||||| + +#### Prepared for Deprecation +![prepared for deprecation](https://img.shields.io/badge/deprecated-red) + +_The following Gems are no longer actively maintained, and awaiting deprecation into the [Samvera Deprecated](https://github.com/samvera-deprecated) Organization._ + +| Gem | CircleCI Status | +| --- | --- | +|[browse-everything](https://github.com/samvera/browse-everything)|[![Build Status](https://circleci.com/gh/samvera/browse-everything.svg?style=svg)](https://circleci.com/gh/samvera/browse-everything)| +|[questioning_authority](https://github.com/samvera/questioning_authority)|[![Build Status](https://circleci.com/gh/samvera/questioning_authority.svg?style=svg)](https://circleci.com/gh/samvera/questioning_authority) +|[rubydora](https://github.com/samvera/rubydora)|[![Build Status](https://circleci.com/gh/samvera/rubydora.svg?style=svg)](https://circleci.com/gh/samvera/rubydora)| + +### Samvera JavaScript Packages + +|Package|CircleCI Status|Node.js 20 Support|Node.js 19 Support|Node.js 18 Support|Node.js 16 Support| +| --- | --- | --- | --- | --- | --- | +|[node-iiif](https://github.com/samvera/node-iiif)|[![Build Status](https://circleci.com/gh/samvera/node-iiif.svg?style=svg)](https://circleci.com/gh/samvera/node-iiif)| | | | | + +### Samvera Infrastructure Projects + +#### CircleCI Orbs +|Application|CircleCI Status| +| --- | --- | +|[samvera-circleci-orb](https://github.com/samvera/samvera-circleci-orb)|[![Build Status](https://circleci.com/gh/samvera/samvera-circleci-orb.svg?style=svg)](https://circleci.com/gh/samvera/samvera-circleci-orb)| + +#### Node.js +|Application|CircleCI Status|Node.js 20 Support|Node.js 19 Support|Node.js 18 Support|Node.js 16 Support| +| --- | --- | --- | --- | --- | --- | +|[samvera.org](https://github.com/samvera/samvera.org)|[![Build Status](https://github.com/samvera/samvera.org/workflows/Deploy%20to%20GitHub%20Pages/badge.svg)](https://github.com/samvera/samvera.org/actions)| +|[serverless-iiif](https://github.com/samvera/serverless-iiif)|[![Build Status](https://circleci.com/gh/samvera/serverless-iiif.svg?style=svg)](https://circleci.com/gh/samvera/serverless-iiif)| | | | | + +### Samvera Administration +| Project | CircleCI Status | +| --- | --- | +|[maintenance](https://github.com/samvera/maintenance)|[![Build Status](https://circleci.com/gh/samvera/serverless-iiif.svg?style=svg)](https://circleci.com/gh/samvera/serverless-iiif)| ## Maintenance Documentation @@ -48,7 +132,7 @@ Currently, there are twenty Samvera Core Components maintained by the community: - [TEAMS](./TEAMS.md) - Reference guide for the structure of GitHub Teams within the `samvera`, `samvera-labs`, and `samvera-deprecated` Organizations - [RELEASES](./ruby/RELEASES.md) - Reference guide for the releasing Ruby Gem components maintained by the Samvera Community -## Samvera Component Templates +## Samvera Project Templates [README.md](./templates/README.md) - The elements in this template should be in every repository. Additional elements may be added. diff --git a/templates/CODE_OF_CONDUCT.md b/templates/CODE_OF_CONDUCT.md index daaaecd..f930830 100644 --- a/templates/CODE_OF_CONDUCT.md +++ b/templates/CODE_OF_CONDUCT.md @@ -1,36 +1,7 @@ -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. +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. +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. +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. +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 [Samvera Code of Conduct and Anti-Harassment Policy](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Samvera+Code+of+Conduct+and+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://samvera.atlassian.net/wiki/spaces/samvera/pages/405211681/Samvera+Community+Helpers) ([email](helpers@samvera.org)), a community member you trust, or the [Samvera Board](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405210594/Samvera+Board+membership) immediately; at Samvera events, these people can be identified by distinctive name badges. The [Anti-Harassment Policy](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Samvera+Code+of+Conduct+and+Anti-Harassment+Policy) should be consulted for fuller details. diff --git a/templates/CONTRIBUTING.md b/templates/CONTRIBUTING.md index 8ebe4f2..ab3c390 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -1,48 +1,26 @@ # How to Contribute -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. +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 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. +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. ## 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 +While there are some [select exceptions](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405211658/Licensed+software+acceptance+procedure), nearly all source code bases produced and maintained by Samvera Community members are published under the [Apache 2.0 License restrictions](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405211660/Code+Copyright+Statement). As such, we please insist that, when creating a new GitHub repository within [https://github.com/samvera-labs](samvera-labs), one please include a copy of the [Apache 2.0 license](./LICENSE) within the repository. You should also add yourself to the `CONTRIBUTORS.md` file in the root of the project. ## Language -The language we use matters. Today, tomorrow, and for years to come -people will read the code we write. They will judge us for our -design, logic, and the words we use to describe the system. +The language we use matters. Today, tomorrow, and for years to come people will read the code we write. They will judge us for our design, logic, and the words we use to describe the system. -Our words should be accessible. Favor descriptive words that give -meaning while avoiding reinforcing systemic inequities. For example, -in the Samvera community, we should favor using allowed_list instead -of whitelist, denied_list instead of blacklist, or source/copy -instead of master/slave. +Our words should be accessible. Favor descriptive words that give meaning while avoiding reinforcing systemic inequities. For example, in the Samvera community, we should favor using allowed_list instead of whitelist, denied_list instead of blacklist, or source/copy instead of master/slave. -We're going to get it wrong, but this is a call to keep working to -make it right. View our code and the words we choose as a chance to -have a conversation. A chance to grow an understanding of the systems -we develop as well as the systems in which we live. +We're going to get it wrong, but this is a call to keep working to make it right. View our code and the words we choose as a chance to have a conversation. A chance to grow an understanding of the systems we develop as well as the systems in which we live. -See [“Blacklists” and “whitelists”: a salutary warning concerning the -prevalence of racist language in discussions of predatory -publishing](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6148600/) for -further details. +See [“Blacklists” and “whitelists”: a salutary warning concerning the prevalence of racist language in discussions of predatory publishing](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC6148600/) for further details. ## Contribution Tasks @@ -77,8 +55,8 @@ further details. - Test functionality with RSpec; Test features / UI with Capybara. - Run _all_ the tests to assure nothing else was accidentally broken. -NOTE: This repository follows the [Samvera Community Code of Conduct](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Code+of+Conduct) -and [language recommendations](#language). +NOTE: This repository follows the [Samvera Community Code of Conduct](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405212316/Samvera+Code+of+Conduct+and+Anti-Harassment+Policy) and [language recommendations](#language). + Please **_do not_** create a branch called `master` for this repository or as part of your pull request; the branch will either need to be removed or renamed before it can be considered for inclusion in the code base and history of this repository. diff --git a/templates/README.md b/templates/README.md index 75f7e7a..c366475 100644 --- a/templates/README.md +++ b/templates/README.md @@ -1,23 +1,21 @@ # {{library}} -Code: [![Version](https://badge.fury.io/rb/{{library}}.png)](http://badge.fury.io/rb/{{library}}) -[![Build Status](https://travis-ci.org/samvera/{{library}}.png?branch=master)](https://travis-ci.org/samvera/{{library}}) -[![Coverage Status](https://coveralls.io/repos/github/samvera/{{library}}/badge.svg?branch=master)](https://coveralls.io/github/samvera/{{library}}?branch=master) +Code: [![Samvera Core Component](https://img.shields.io/badge/samvera-core--component-brightgreen)](https://github.com/samvera/maintenance#samvera-core-components) +[![Build Status](https://circleci.com/gh/samvera/{{library}}.svg?style=svg)](https://circleci.com/gh/samvera/{{library}}) +[![Version](https://badge.fury.io/rb/{{library}}.png)](http://badge.fury.io/rb/{{library}}) 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) -Jump in: [![Slack Status](http://slack.samvera.org/badge.svg)](http://slack.samvera.org/) +Community Support: [![Samvera Community Slack](https://img.shields.io/badge/samvera-slack-blueviolet)](http://slack.samvera.org/) # What is {{library}}? Enter a description of the library here. -## Product Owner & Maintenance +## Product Owner and Maintenance -{{library}} 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). +{{library}} 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 @@ -25,11 +23,11 @@ what this means can be found # Help -The Samvera community is here to help. Please see our [support guide](./SUPPORT.md). +The Samvera community is here to help. Please see the [support guide](./SUPPORT.md). # Getting Started -Give a description w/ examples of how to use the library. +Give a description with examples of how to use the library. ## Prerequisites @@ -37,7 +35,6 @@ Include any system-level dependencies this library has. # Acknowledgments -This software has been developed by and is brought to you by the Samvera community. Learn more at the -[Samvera website](http://samvera.org/). +This software has been developed by and 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) diff --git a/templates/SUPPORT.md b/templates/SUPPORT.md index 5058e04..63d9268 100644 --- a/templates/SUPPORT.md +++ b/templates/SUPPORT.md @@ -2,4 +2,4 @@ If you would like to report an issue, first search [the list of issues](https:// 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://samvera.atlassian.net/wiki/spaces/samvera/pages/405211682/Getting+Started+in+the+Samvera+Community#Join-the-Samvera-Slack-workspace). -You can learn more about the various Samvera communication channels on the [Getting Started in the Samvera Community](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405211682/Getting+Started+in+the+Samvera+Community) wiki page. +You can learn more about the various Samvera communication channels on the [Getting Started in the Samvera Community](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405211682/Getting+Started+in+the+Samvera+Community#Join-the-Samvera-Slack-workspace) wiki page.