Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/blank_issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Blank issue
description: Create a new issue from scratch
body:
- type: markdown
attributes:
value: |
Thank you for contributing an issue to our project!
- type: markdown
attributes:
value: |
If you are reporting a bug or requesting a feature, please click "Choose a different template" above.
- type: textarea
id: description
attributes:
label: Description
validations:
required: true
77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: Bug Report
description: Identify a problem or unexpected outcome
title: "[Bug]: "
labels: ["bug"]
body:
- type: textarea
id: bug-description
attributes:
label: Bug description
description: Please explain the problem you are experiencing
validations:
required: true
- type: input
id: version
attributes:
label: Version
description: What version of our product are you using?
placeholder: X.X.X
validations:
required: true
- type: dropdown
id: operating-system
attributes:
label: Operating system
description: What operating system are you using?
options:
- Windows
- Mac
- Linux
validations:
required: true
- type: textarea
id: system-info
attributes:
label: System information
description: Please provide the following system information
value: |
- R version:
- IDE:
- IDE version:
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: Reproduction steps
description: Please explain the steps required to reproduce the problem. Ideally, include a minimal reproducible example (AKA a reprex). If you've never heard of a [reprex](http://reprex.tidyverse.org/) before, start by reading <https://www.tidyverse.org/help/#reprex>.
validations:
required: true
- type: textarea
id: actual-result
attributes:
label: Actual result
description: What is the observed outcome of following the steps above?
validations:
required: true
- type: textarea
id: expected-result
attributes:
label: Expected result
description: What outcome did you expect from following the steps above?
validations:
required: true
- type: input
id: bug-impact
attributes:
label: Bug impact
description: How severely does this problem impact you and/or your work?
validations:
required: true
- type: upload
id: screenshots
attributes:
label: Upload screenshots
description: If applicable, you may upload screenshots to demonstrate the problem.
validations:
required: false
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Feature Request
description: Request the addition of a new feature
title: "[Feature]: "
labels: ["feature"]
body:
- type: textarea
id: feature-description
attributes:
label: Feature description
description: Please explain the feature you are requesting
validations:
required: true
- type: textarea
id: feature-reason
attributes:
label: Justification
description: How would this feature improve your use of our product?
validations:
required: true
- type: textarea
id: example-features
attributes:
label: Examples
description: If applicable, please provide an example of the feature. If you have seen or used an analagous feature elsewhere, please provide a link to it.
validations:
required: false
- type: upload
id: screenshots
attributes:
label: Upload screenshots
description: If applicable, you may upload screenshots to supplement your request.
validations:
required: false
25 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/dev_pr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
PRs into `dev` contained all necessary info. They have already been approved.
Please provide the information below so `main` can be synced with `dev`:

### List PRs

List the PRs that were merged into `dev` that will be pulled into `main` and any issues they fix:

* PR #? which fixes #?

### Types of changes

What types of changes does this pull request introduce? Put an `x` in the boxes that apply.
This will inform the new release number.

- [ ] Fix (non-breaking change which fixes a bug)
- [ ] Feature (non-breaking change which adds or changes functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Other change (if none of the other choices apply)

### Reviewer instructions

The underlying PRs should have been reviewed. Please check that the proposed merge is correct before approving.
If any checkboxes other than "Other change" have been selected please prepare the following file changes for a new release version:
- [ ] NEWS.md - add release notes
- [ ] DESCRIPTION - increment the version number according to [Semantic Versioning](https://semver.org)
36 changes: 36 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Your commits explain the `who`, `what`, `where` and `when` of these changes. Your code shows the `how`. You do not need to reiterate this. This PR should complete the picture by explaining `why` these changes are necessary.
Please complete the fields below, replacing or removing placeholder text where necessary:

### Justification

Please describe the importance/impact of the problem and a description of how the changes in this pull request will address, resolve or improve it. This section should sufficiently explain to reviewers why these changes should be approved.
If the proposed changes should close an issue, be sure to link to it below:
Fixes #?

### Types of changes

What types of changes does this pull request introduce? Put an `x` in the boxes that apply.
This will inform the new release number.

- [ ] Fix (non-breaking change which fixes a bug)
- [ ] Feature (non-breaking change which adds or changes functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Other change (if none of the other choices apply)

### Further comments

If this is a relatively large or complex change, kick off a discussion by explaining why you chose the solution you did, what alternatives you considered, problems you may have encountered, etc.

### Reviewer instructions

Assign at least 2 reviewers:
* one of which should be a maintainer of this repo,
* the others should be familiar with the subject or problem.

Please detail the process reviewers will need to follow to properly test these changes. It is especially helpful to identify the exact code needed to conduct a local build/review/test and to specify any aspects of the testing that may not be obvious.

### Formatting

This repo contains an `air.toml` file that automatically formats code to a set of standards.
It is preferred that contributors and reviewers install the [Air](https://posit-dev.github.io/air/) formatting tool.
Code submitted in this pull request will be automatically checked for correct formatting.
68 changes: 68 additions & 0 deletions .github/workflows/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# NOAA Fisheries Open Science Code of Conduct

This code of conduct was developed and adapted from the Atom code of conduct in October 2021,
and revised from NOAA-NMFS-Brand-Resources in June 2024

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone.

## Our Standards

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

* 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

Examples of unacceptable behavior by participants include:

* The use of sexualized 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

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

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 behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via 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.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported
by contacting the project team. All complaints will be reviewed and investigated
and will result in a response that is deemed necessary and appropriate to the
circumstances. Further details of specific enforcement policies may be posted
separately.

## Attribution

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.html


Loading
Loading