From edbb6c060930e64b85c51419713e6691db23583f Mon Sep 17 00:00:00 2001 From: Sam Schiano <125507018+Schiano-NOAA@users.noreply.github.com> Date: Mon, 18 May 2026 16:16:22 -0400 Subject: [PATCH 1/7] copy contrib and adjust from asar --- CONTRIBUTING.md | 74 +++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 69 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d322b3ab..14026fa0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,9 @@ -# Contributing to {stockplotr} +# Contributing to `stockplotr` -Do you have an idea that would improve {stockplotr}? *Consider making a contribution!* We welcome ideas for improving not only our code, but also our documentation, tutorial, and any other material associated with {stockplotr}. Here are some options and tips for doing so. +Do you have an idea that would improve `stockplotr`? *Consider making a contribution!* +We welcome ideas for improving not only our code, but also our documentation, +tutorial, and any other material associated with `stockplotr`. Here are some +options and tips for doing so. Note: To make any contribution, you must agree to abide by the [Code of Conduct](https://github.com/nmfs-ost/stockplotr/blob/main/CODE_OF_CONDUCT.md). @@ -8,19 +11,80 @@ Note: To make any contribution, you must agree to abide by the [Code of Conduct] ### Recommended workflow: fork & submit a pull request -The most efficient way to contribute an idea is to fork {stockplotr}, make your suggested changes on a local branch, and then submit a pull request. This will allow the developers to easily evaluate your suggested changes. Please see the [GitHub Docs' "Contributing to a project" page](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project) for step-by-step guidance in using this workflow. +The most efficient way to contribute an idea is to fork `asar`, make your +suggested changes on a local branch, and then submit a pull request to the main branch. +This will allow the developers to easily evaluate your suggested changes. +Please see the [GitHub Docs' "Contributing to a project" page](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project) +for step-by-step guidance in using this workflow. + +We also follow a few other practices that will help us expedite the review process. +After completing the bug fix or feature, please complete the following: + +1. Run `devtools::test()` to verify the package checks are passing (this includes tests). + +2. If including a feature, please add a test using the +[`{testthat}` package structure](https://testthat.r-lib.org/reference/test_that.html). +If you are unfamiliar with this approach, simply let us know :smile + +3. If including a feature that is a new function, please add documentation using +the [`{roxygen2}` package structure](https://roxygen2.r-lib.org/articles/roxygen2.html). + +4. Please increment the package version following our semantic versioning found in @sec-version. + +5. Add a short summary or title line in the NEWS.md file indicating the feature +or fix. This will be how we include recognition for your contribution in our +monthly release notes. ### Recommended practices - Write clear, succinct commit messages ([see some tips here](https://opensource.com/article/22/12/git-commit-message)) - Limit a commit to a few, rather than many, changes. Smaller commits means more commit messages, which is often helpful for documentation. -- Ensure your base branch is correct. +- Ensure your base branch is correct. We typically merge most PRs into "dev", then merge "dev" into "main" upon a new release. - Test that your contributed code will function as expected under different circumstances. - Add comments to the code if it's not immediately clear what the purpose of the code is, or how it works. +### Semantic Versioning {#sec-version} + +We use an approach to semantic versioning for our packages. This includes using +a typical structure for semantic versioning which follows: + +v.. + +where, + +- MAJOR = major release (not backwards compatible) +- MINOR = minor release (new features) +- PATCH = hot fixes and bug fixes (aka patches) + +A branch in v...9000 indicates development in main branch. + +Please use the following "release indicators" for a naming a branch or pull request: + +| Indicator | Description | +|-----------|-------------| +| feat | A new feature | +| fix | A bug fix | +| docs | Documentation only changes | +| style | Changes that do not affect the meaning of the code (i.e. white-space, formatting, missing semi-colons) | +| refactor | A code change that neither fixes a bug nor adds a feature | +| perf | A code change that improves performance | +| test | Adding missing or correcting existing tests | +| chore | changes to the build process or auxiliary tools and libraries such as documentation generation | + +#### Rules for Indicator Use + +- If the body contains the text "BREAKING CHANGE" then MAJOR version is incremented. +- If the type contains feat, then MINOR version is incremented. +- If the type contains a fix, then PATCH version is incremented. +- If the type contains refactor/style/perf/doc/test/chore, then nothing is incremented and no release will be made. + + +The above content is modeled after an article on ["Automating Versioning and Releases Using Semantic Release"](https://medium.com/agoda-engineering/automating-versioning-and-releases-using-semantic-release-6ed355ede742) +from Agoda Engineering. + ## Contributing bugs -Found a bug? Tell us about it on our [Issues page](https://github.com/nmfs-ost/stockplotr/issues). Before you create an issue, please check that it has not already been resolved (i.e., is a "closed" issue). +Found a bug? Tell us about it on our [Issues page](https://github.com/nmfs-ost/stockplotr/issues). Before you create an issue, please check that it has not already been resolved (i.e., is a "closed" issue) or documented in our [Frequently Asked Questions (FAQ) vignette](https://nmfs-ost.github.io/stockplotr/articles/faqs.html). If possible, please submit a reproducible example ([reprex](https://reprex.tidyverse.org/articles/reprex-dos-and-donts.html)) to help us understand the problem better and, ideally, allow us to reproduce your issue. From 5235ddac24a5014c32bdf7221c232f7d4f1394b9 Mon Sep 17 00:00:00 2001 From: Sam Schiano <125507018+Schiano-NOAA@users.noreply.github.com> Date: Mon, 18 May 2026 16:17:42 -0400 Subject: [PATCH 2/7] add link to version section --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14026fa0..e4380f85 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ If you are unfamiliar with this approach, simply let us know :smile 3. If including a feature that is a new function, please add documentation using the [`{roxygen2}` package structure](https://roxygen2.r-lib.org/articles/roxygen2.html). -4. Please increment the package version following our semantic versioning found in @sec-version. +4. Please increment the package version following our [semantic versioning section](https://github.com/nmfs-ost/stockplotr/blob/doc-update-contrib/CONTRIBUTING.md#semantic-versioning-sec-version). 5. Add a short summary or title line in the NEWS.md file indicating the feature or fix. This will be how we include recognition for your contribution in our @@ -43,7 +43,7 @@ monthly release notes. - Test that your contributed code will function as expected under different circumstances. - Add comments to the code if it's not immediately clear what the purpose of the code is, or how it works. -### Semantic Versioning {#sec-version} +### Semantic Versioning We use an approach to semantic versioning for our packages. This includes using a typical structure for semantic versioning which follows: From 28c948fead65ff198b2109b0258934bcd8140de8 Mon Sep 17 00:00:00 2001 From: Sam Schiano <125507018+Schiano-NOAA@users.noreply.github.com> Date: Mon, 18 May 2026 16:18:20 -0400 Subject: [PATCH 3/7] add code ticks around versioning --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4380f85..9718165a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,7 +48,7 @@ monthly release notes. We use an approach to semantic versioning for our packages. This includes using a typical structure for semantic versioning which follows: -v.. +`v..` where, @@ -56,7 +56,7 @@ where, - MINOR = minor release (new features) - PATCH = hot fixes and bug fixes (aka patches) -A branch in v...9000 indicates development in main branch. +A branch in `v...9000` indicates development in main branch. Please use the following "release indicators" for a naming a branch or pull request: From 968f2b13bba3e059a7260b9e73e467d86e48ddec Mon Sep 17 00:00:00 2001 From: Sam Schiano <125507018+Schiano-NOAA@users.noreply.github.com> Date: Mon, 18 May 2026 16:43:03 -0400 Subject: [PATCH 4/7] update contributing, add NEWS.md file with help from the helper package Dschaykib/newsmd --- CONTRIBUTING.md | 4 ++-- NEWS.md | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+), 2 deletions(-) create mode 100644 NEWS.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9718165a..007d3762 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,8 +79,8 @@ Please use the following "release indicators" for a naming a branch or pull requ - If the type contains refactor/style/perf/doc/test/chore, then nothing is incremented and no release will be made. -The above content is modeled after an article on ["Automating Versioning and Releases Using Semantic Release"](https://medium.com/agoda-engineering/automating-versioning-and-releases-using-semantic-release-6ed355ede742) -from Agoda Engineering. +**The above content is modeled after an article on ["Automating Versioning and Releases Using Semantic Release"](https://medium.com/agoda-engineering/automating-versioning-and-releases-using-semantic-release-6ed355ede742) +from Agoda Engineering.** ## Contributing bugs diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 00000000..0db1a27b --- /dev/null +++ b/NEWS.md @@ -0,0 +1,21 @@ +## version v0.11.1 + +--- + + +### Features + + + +### Bugfixes + + + +## version 0.0.0.9000 + +--- + +### NEWS.md setup + +- added NEWS.md creation with [newsmd](https://github.com/Dschaykib/newsmd) + From 599aa33b4dc477d9c3dfd5d5f1e3feff2a52a843 Mon Sep 17 00:00:00 2001 From: Sam Schiano <125507018+Schiano-NOAA@users.noreply.github.com> Date: Mon, 18 May 2026 16:47:58 -0400 Subject: [PATCH 5/7] add link to NEWS file in main --- CONTRIBUTING.md | 4 ++-- NEWS.md | 3 --- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 007d3762..179b77e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,7 @@ the [`{roxygen2}` package structure](https://roxygen2.r-lib.org/articles/roxygen 4. Please increment the package version following our [semantic versioning section](https://github.com/nmfs-ost/stockplotr/blob/doc-update-contrib/CONTRIBUTING.md#semantic-versioning-sec-version). -5. Add a short summary or title line in the NEWS.md file indicating the feature +5. Add a short summary or title line in the [NEWS.md](https://github.com/nmfs-ost/stockplotr/blob/main/NEWS) file indicating the feature or fix. This will be how we include recognition for your contribution in our monthly release notes. @@ -80,7 +80,7 @@ Please use the following "release indicators" for a naming a branch or pull requ **The above content is modeled after an article on ["Automating Versioning and Releases Using Semantic Release"](https://medium.com/agoda-engineering/automating-versioning-and-releases-using-semantic-release-6ed355ede742) -from Agoda Engineering.** +# from Agoda Engineering.** ## Contributing bugs diff --git a/NEWS.md b/NEWS.md index 0db1a27b..697c1425 100644 --- a/NEWS.md +++ b/NEWS.md @@ -10,9 +10,6 @@ ### Bugfixes - -## version 0.0.0.9000 - --- ### NEWS.md setup From 125eaf4bb7702a9596ed697c0ea7df947305531e Mon Sep 17 00:00:00 2001 From: Sam Schiano <125507018+Schiano-NOAA@users.noreply.github.com> Date: Mon, 18 May 2026 17:04:39 -0400 Subject: [PATCH 6/7] update WORDLIST --- inst/WORDLIST | 3 +++ 1 file changed, 3 insertions(+) diff --git a/inst/WORDLIST b/inst/WORDLIST index 21b67429..f6a703d6 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -1,4 +1,5 @@ BAM +Bugfixes CPUE FIMS FIMSdiags @@ -42,8 +43,10 @@ kableExtra kobe kqs len +md msy natively +newsmd noaa nsim obsvpred From 02656a275ec9949567ab8a3cf9d13a666643b4bb Mon Sep 17 00:00:00 2001 From: Sam Schiano <125507018+Schiano-NOAA@users.noreply.github.com> Date: Tue, 19 May 2026 09:37:44 -0400 Subject: [PATCH 7/7] remove mention of using dev branch --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 179b77e8..e5b0eb7c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,7 +39,7 @@ monthly release notes. - Write clear, succinct commit messages ([see some tips here](https://opensource.com/article/22/12/git-commit-message)) - Limit a commit to a few, rather than many, changes. Smaller commits means more commit messages, which is often helpful for documentation. -- Ensure your base branch is correct. We typically merge most PRs into "dev", then merge "dev" into "main" upon a new release. +- Ensure your base branch is correct. We merge all branches into main. - Test that your contributed code will function as expected under different circumstances. - Add comments to the code if it's not immediately clear what the purpose of the code is, or how it works.