From 46bb74e57c7ab6a9c898a7e165d0dd378ecc4af0 Mon Sep 17 00:00:00 2001 From: David LeBauer Date: Thu, 27 Jun 2024 10:29:26 -0400 Subject: [PATCH] Update CONTRIBUTING.md added instructions to update CHANGELOG, NEWS, CITATION files do we have a threshold for authorship? currently 'non-trivial change' --- CONTRIBUTING.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 023c3afe99a..d1118f69680 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -86,7 +86,16 @@ git checkout -b GH-issuenumber-title-of-issue ### Work and commit -Do you work, and commit as you see fit.Make your commit messages helpful. +Do you work, and commit as you see fit. Make your commit messages helpful. + +### Update other files (CITATION, NEWS, CHANGELOG) + +Your PR should include: + +- CITATION.cff: if you are making or have made a non-trivial contribution (please ask if unsure; our approach is inclusive), add your name to the author section. +- NEWS.md: for each package +- CHANGELOG.md: add changes to [Unreleased] section + ### Push your changes up to GitHub @@ -96,6 +105,7 @@ If this is the first time pushing to GitHub you will need to extended command, o git push -u origin GH-issuenumber-title-of-issue ``` + ### Pull Request When finished create a pull request from your branch to the main pecan repository.