Skip to content

Commit

Permalink
Update project metadata (#67)
Browse files Browse the repository at this point in the history
* Update project metadata
* Comma error
  • Loading branch information
mattkerlogue committed Apr 29, 2022
1 parent 34308fb commit d830408
Show file tree
Hide file tree
Showing 6 changed files with 133 additions and 120 deletions.
175 changes: 71 additions & 104 deletions CODE_OF_CONDUCT.md
@@ -1,128 +1,95 @@
# Contributor Covenant Code of Conduct
# Code of Conduct for `a11ytables`

## Our Pledge
Contributors to this repository hosted by `co-analysis` are expected to follow
the Contributor Covenant Code of Conduct, and those working within Her Majesty's
Government are also expected to follow the Civil Service Code.

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
## Definitions

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
Where this Code of Conduct says:

## Our Standards
- "Project", we mean this `a11ytables` GitHub repository;
- "Maintainer", we mean the `co-analysis` organisation owners; and
- "Leadership", we mean both `co-analysis` organisation owners, line managers, and other
leadership within the Cabinet Office.

Examples of behavior that contributes to a positive environment for our
community include:
## Civil Service Code

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community
Contributors working within Her Majesty's Government must review the
[Civil Service Code](https://www.gov.uk/government/publications/civil-service-code/the-civil-service-code),
and are expected to follow it in their contributions.

Examples of unacceptable behavior include:
## Contributor Covenant Code of Conduct

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
### Our Pledge

## Enforcement Responsibilities
In the interest of fostering an open and welcoming environment, we as contributors
and maintainers pledge to make participation in our project, and our community a
harassment-free experience for everyone, regardless of age, body size, disability,
ethnicity, sex characteristics, gender identity and expression, level of experience,
education, socio-economic status, nationality, personal appearance, race, religion,
or sexual identity and orientation.

Community leaders are responsible for clarifying and enforcing our standards
of acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
### Our Standards

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.
Examples of behaviour that contributes to creating a positive environment include:

## Scope
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

This Code of Conduct applies within all community spaces, and also applies
when an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event.
Examples of unacceptable behaviour by participants include:

## Enforcement
- The use of sexualised language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at [INSERT CONTACT
METHOD]. All complaints will be reviewed and investigated promptly and fairly.
### Our Responsibilities

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
Project maintainers are responsible for clarifying the standards of acceptable
behaviour and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behaviour.

## Enforcement Guidelines
Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviours that they deem inappropriate, threatening,
offensive, or harmful.

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### Scope

### 1. Correction
This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official project
e-mail address, posting using an official social media account, or acting as an
appointed representative at an online or offline event. Representation of a
project may be further defined and clarified by project maintainers.

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
### Enforcement

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
Instances of abusive, harassing, or otherwise unacceptable behaviour may be
reported by contacting the project team at
[matt.dray@cabinetoffice.gov.uk](mailto:matt.dray@cabinetoffice.gov.uk). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

### 2. Warning
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

**Community Impact**: A violation through a single incident or series of
actions.
### Attribution

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0,
available at https://www.contributor-covenant.org/version/2/0/
code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at https://
www.contributor-covenant.org/translations.
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
version 1.4, available at
[https://www.contributor-covenant.org/version/1/4/code-of-conduct/](https://www.contributor-covenant.org/version/1/4/code-of-conduct/),
and the `alphagov` Code of Conduct available at
[https://github.com/alphagov/.github/blob/main/CODE_OF_CONDUCT.md](https://github.com/alphagov/.github/blob/main/CODE_OF_CONDUCT.md).
4 changes: 3 additions & 1 deletion DESCRIPTION
Expand Up @@ -2,9 +2,11 @@ Package: a11ytables
Title: Create Spreadsheet Publications Following GSS Best Practice
Version: 0.0.0.90015
Authors@R: c(
person(given = "Crown Copyright", role = c("cph", "fnd")),
person(given = "Matt", family = "Dray", role = c("aut", "cre"), email = "mwdray@gmail.com"),
person(given = "Tim", family = "Taylor", role = "ctb"),
person(given = "Crown Copyright", role = "cph"))
person(given = "Matt", family = "Kerlogue", role = "ctb")
)
Description: Generate spreadsheet publications for official release by UK
government organisations following best practice guidance from the UK's
Government Statistical Service (GSS), with a focus on accessibility for all
Expand Down
8 changes: 5 additions & 3 deletions README.Rmd
Expand Up @@ -59,8 +59,10 @@ The package can help you fulfil a [Reproducible Analytical Pipeline](https://dat

## Code of Conduct

Please note that the {a11ytables} project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms. Cabinet Office users, please adhere to [the co-analysis Git and GitHub code of conduct and usage policy](https://docs.google.com/document/d/1CuNgKla1BwSVOmGkPmsq0S-OM4emP-iXrgnm7EeILWM/edit?usp=sharing).
Please note that the {a11ytables} project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.html).

## Copyright
## Copyright and Licensing

Copyright (c) 2022 Crown Copyright (Cabinet Office). The code in this repository is released under the MIT license as per [The GDS Way](https://gds-way.cloudapps.digital/manuals/licensing.html#use-mit).
© Crown Copyright, 2022, Cabinet Office

This work is [Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/). The source code for the software is released under the MIT licence as per the the [UK Government Licensing Framework](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/open-government-licence/open-software-licences/) and the [GDS Way licensing guidance](https://gds-way.cloudapps.digital/manuals/licensing.html). The documentation for the software is released under the [Open Govenrment Licence](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/)
27 changes: 15 additions & 12 deletions README.md
Expand Up @@ -78,15 +78,18 @@ by automating the generation of compliant spreadsheets for publication.
## Code of Conduct

Please note that the {a11ytables} project is released with a
[Contributor Code of
Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.
Cabinet Office users, please adhere to [the co-analysis Git and GitHub
code of conduct and usage
policy](https://docs.google.com/document/d/1CuNgKla1BwSVOmGkPmsq0S-OM4emP-iXrgnm7EeILWM/edit?usp=sharing).

## Copyright

Copyright (c) 2022 Crown Copyright (Cabinet Office). The code in this
repository is released under the MIT license as per [The GDS
Way](https://gds-way.cloudapps.digital/manuals/licensing.html#use-mit).
[Contributor Code of Conduct](CODE_OF_CONDUCT.html).

## Copyright and Licensing

© Crown Copyright, 2022, Cabinet Office

This work is [Crown
Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/).
The source code for the software is released under the MIT licence as
per the the [UK Government Licensing
Framework](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/open-government-licence/open-software-licences/)
and the [GDS Way licensing
guidance](https://gds-way.cloudapps.digital/manuals/licensing.html). The
documentation for the software is released under the [Open Govenrment
Licence](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/)
16 changes: 16 additions & 0 deletions inst/CITATION
@@ -0,0 +1,16 @@
citHeader("To cite a11ytables in publications use:")

citEntry(
entry = "Manual",
title = "a11ytables: Create Spreadsheet Publications Following GSS Best Practice",
author = person(given = "Matt", family = "Dray", role = c("aut", "cre"), email = "mwdray@gmail.com"),
year = "2021",
organization = "Crown Copyright (Cabinet Office)",
url = "https://github.com/co-analysis/a11ytables",
textVersion = paste(
"Dray M (2021)",
"a11ytables: Create Spreadsheet Publications Following GSS Best Practice,",
"Crown Copyright (Cabinet Office),",
"https://github.com/co-analysis/a11ytables"
)
)
23 changes: 23 additions & 0 deletions inst/COPYRIGHT
@@ -0,0 +1,23 @@
© Crown Copyright, 2022, Cabinet Office

This work is Crown Copyright, it is released in accordance with the
UK Government Licensing Framework set out by The National Archives.

The source code for the software is released under the MIT licence
as per the UK Government Licensing Framework and GDS Way licensing guidance.

The documentation for the software is released under the Open Govenrment Licence.

RELATED LINKS:

* Crown Copyright:
https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/

* UK Government Licencing Framework guidance:
https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/open-government-licence/open-software-licences/

* GDS Way licensing guidance:
https://gds-way.cloudapps.digital/manuals/licensing.html

* Open Government Licence:
https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/)

0 comments on commit d830408

Please sign in to comment.