Skip to content

Commit

Permalink
Add contributing guidelines and GitHub templates (#113)
Browse files Browse the repository at this point in the history
* add license, contributing notes and templates

* quick tidy of README, adding links to contributing guidance

* Add suggested process for raising new changes to the package
  • Loading branch information
cjrace authored Dec 5, 2024
1 parent fa15a10 commit 3ddc104
Show file tree
Hide file tree
Showing 9 changed files with 805 additions and 69 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@
^docs$
^pkgdown$
^\.github$
^LICENSE\.md$
34 changes: 34 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Code of Conduct

As contributors and maintainers of this project, we pledge to follow the [Contributor Covenant](https://www.contributor-covenant.org/) in our interactions with others. We value an open and welcoming environment where everyone feels respected and heard.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

- Being respectful and considerate of differing viewpoints.
- Using welcoming and inclusive language.
- Focusing on what is best for the community.
- Showing empathy towards other community members.

Examples of unacceptable behavior include:

- Harassment, trolling, or derogatory comments.
- Personal attacks or insults.
- Any form of discrimination.

## Our Responsibilities

Project maintainers are responsible for clarifying and enforcing our standards of behavior. They have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned with this Code of Conduct.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and address any reported issues promptly.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/).
43 changes: 43 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributing to shinyGovstyle

Ideas for shinyGovstyle should first be raised as a [GitHub issue](https://github.com/moj-analytical-services/shinyGovstyle/issues) after which anyone is free to write the code and create a pull request for review.

For support and information on package development in R, we recommend using the [R Packages (2e) guide by Hadley Wickham and Jennifer Bryan](https://r-pkgs.org/), this contains a wealth of information and best practice for all kinds of activities around package development in R.

## Raising new changes

New changes should be made on a branch off of the latest version of the master branch.

If you don't have access to push to the repo itself, you should start by creating a [fork of the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#forking-a-repository). You'll then be able to make a new branch in your own repo and push your suggested changes to that.

Once ready, you should raise [a PR in the main GitHub repository](https://github.com/moj-analytical-services/shinyGovstyle/compare), pointing at the `master` branch and one of the package maintainers will be able to review your changes.

Once a pull request is reviewed and ready to be merged in, all commits in the PR should be squashed as a part of the merge to keep the Git history shorter and easier to navigate.

The `master` branch acts as the development version of the package for users, releases of stable package versions to CRAN will be made by the maintainers when they feel it is appropriate to do so.

## CSS changes

All changes made to the main `inst/www/css/govuk-frontend-norem.css` file should be logged in the `css_changes.md` file, this way they can easily be reapplied whenever the CSS assests from GOV.UK are updated.

Alternatively, you can start a separate CSS file if your styling is separate to the GOV.UK styling.

## Updating to latest GOV.UK Frontend version

Currently we take [static precompiled exports of the GOV.UK Frontend files](https://frontend.design-system.service.gov.uk/install-using-precompiled-files/), and then store them in the `inst/` directory. Usual steps involved:

1. Locate the latest (or desired) [GOV.UK Frontend version on GitHub](https://github.com/alphagov/govuk-frontend/releases)

2. Download and unzip the ZIP folder, copying the assets (including fonts and images) into the `inst/www/` folder

3. Apply any changes from `css_changes.md` manually, to preserve previous edits

4. Test all the code functions as expected using `devtools::check()`

5. Manually test the examples using `shinyGovstyle::run_example()`, ensuring the styling is as expected

If unsure on the styling and expected appearance, use the [GOV.UK Design System site](https://design-system.service.gov.uk/) to explore the components in more detail and official guidance for their use.

## Code of Conduct

Please note that the shinyGovstyle project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this project you agree to abide by its terms.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

## Overview
<!-- A clear and concise description of what the bug is. -->

## How to reproduce
Steps to reproduce the behaviour:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Expected behaviour
<!-- A clear and concise description of what you expected to happen instead.-->

## Screenshots
<!-- If applicable, add screenshots to help explain your problem. -->

## Additional context
<!-- Add any other context about the problem here. -->
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

## Describe the solution you'd like
<!-- A clear and concise description of what you want to happen.-->

## Describe alternatives you've considered
<!-- A clear and concise description of any alternative solutions or features you've considered (or if you haven't, still say so as that's still helpful information so others know if it's worth looking at or suggesting alternatives).-->

## Additional context
<!--Add any other context or screenshots about the feature request here.-->
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Overview of changes

<!-- Briefly describe the purpose of this pull request. Why is the change being made? -->

<!-- Add any relevant screenshots or images, including before and after if possible. -->

<!-- If this PR is related to any existing issues, mention them here (e.g., "Fixes #123"). -->

## PR Checklist

- [ ] I have updated the documentation (if needed)
- [ ] I have added or updated tests for these changes (if applicable)
- [ ] I have tested these changes locally using `devtools::check()`

## Reviewer instructions

<!-- Put any specific questions, instructions or notes for reviewers in here -->
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Authors@R: c(
Description: Collection of 'shiny' application styling that are the based
on the GOV.UK Design System. See
<https://design-system.service.gov.uk/components/> for details.
License: GPL-3
License: GPL (>= 3)
URL: https://github.com/moj-analytical-services/shinyGovstyle
BugReports:
https://github.com/moj-analytical-services/shinyGovstyle/issues
Expand Down
Loading

0 comments on commit 3ddc104

Please sign in to comment.