Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
added instructions to update CHANGELOG, NEWS, CITATION files

do we have a threshold for authorship? currently 'non-trivial change'
  • Loading branch information
dlebauer authored Jun 27, 2024
1 parent 877a2f2 commit 46bb74e
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down

0 comments on commit 46bb74e

Please sign in to comment.