From 6773c12e64e471441e575a6497a2de17455ed88e Mon Sep 17 00:00:00 2001 From: jrgriffiniii <1443986+jrgriffiniii@users.noreply.github.com> Date: Thu, 16 Mar 2023 17:17:22 -0400 Subject: [PATCH] Fixing the Prettier violations --- .prettierignore | 5 ++++- templates/CODE_OF_CONDUCT.md | 6 +++--- templates/CONTRIBUTING.md | 28 ++++++++++++++-------------- 3 files changed, 21 insertions(+), 18 deletions(-) diff --git a/.prettierignore b/.prettierignore index 42061c0..cfedaea 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1 +1,4 @@ -README.md \ No newline at end of file +README.md +# templates/CODE_OF_CONDUCT.md +# templates/CONTRIBUTING.md +templates/README.md diff --git a/templates/CODE_OF_CONDUCT.md b/templates/CODE_OF_CONDUCT.md index d75345f..f930830 100644 --- a/templates/CODE_OF_CONDUCT.md +++ b/templates/CODE_OF_CONDUCT.md @@ -1,7 +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. -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 [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. \ No newline at end of file +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 2320518..ab3c390 100644 --- a/templates/CONTRIBUTING.md +++ b/templates/CONTRIBUTING.md @@ -14,11 +14,11 @@ You should also add yourself to the `CONTRIBUTORS.md` file in the root of the pr ## 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. @@ -43,17 +43,17 @@ See [“Blacklists” and “whitelists”: a salutary warning concerning the pr ### Making Changes -* Fork the repository on GitHub -* Create a topic branch from where you want to base your work. - * This is usually the `main` branch. - * To quickly create a topic branch based on `main`; `git branch fix/main/my_contribution main` - * Then checkout the new branch with `git checkout fix/main/my_contribution`. - * Please avoid working directly on the `main` branch. - * Please do not create a branch called `master`. (See note below.) - * 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. +- Fork the repository on GitHub +- Create a topic branch from where you want to base your work. + - This is usually the `main` branch. + - To quickly create a topic branch based on `main`; `git branch fix/main/my_contribution main` + - Then checkout the new branch with `git checkout fix/main/my_contribution`. + - Please avoid working directly on the `main` branch. + - Please do not create a branch called `master`. (See note below.) + - 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. 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).