Skip to content

Commit 207b008

Browse files
committed
update README links to contribution guide and link to permanent doi on Zenodo
1 parent d020f0e commit 207b008

File tree

2 files changed

+25
-11
lines changed

2 files changed

+25
-11
lines changed

README.Rmd

+9-3
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,13 @@ devtools::install_github("mcsiple/mmrefpoints")
6868

6969
## Contributing [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dwyl/esta/issues)
7070
### Community guidelines
71-
We would like this package to be sustainable in the long term and welcome contributions. If you encounter a bug, please leave a note on the [Issues page](https://github.com/mcsiple/mmrefpoints/issues). You can also leave comments there about additional functionality (please add the "enhancement" label to your issue).
71+
We would like this package to be sustainable in the long term and welcome contributions. If you are interested in contributing, please check out our [Contribution Guide](https://github.com/mcsiple/mmrefpoints/blob/master/CONTRIBUTING.md).
72+
73+
Bugs and enhancements are tracked through GitHub issues. If you have a bug to report, there is a [bug report template](https://github.com/mcsiple/mmrefpoints/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) to help maximize the benefit of your report for everyone. The same goes for requests for [enhancements](https://github.com/mcsiple/mmrefpoints/blob/master/.github/ISSUE_TEMPLATE/feature_request.md).
74+
75+
76+
7277

73-
If you are interested in contributing, we direct you to the R package [contribution advice](http://r-pkgs.had.co.nz/git.html) from Hadley Wickham.
7478

7579
## Accessing the MMBIET Shiny app
7680
The functions in this package can also be accessed through the Shiny app for this project, which is located online [here](https://msiple.shinyapps.io/mmrefpoints/). The app provides an easy way to explore outcomes and print out a report with inputs and outputs.
@@ -180,4 +184,6 @@ To cite this package or the MMBIET Shiny app, please use the following citation:
180184
> Margaret C. Siple, André E. Punt, Tessa B. Francis, Philip S. Hammond, Dennis Heinemann, Kristy J. Long, Jeffrey E. Moore,
181185
Randall R. Reeves, Sepúlveda Maritza, Guðjón Már Sigurðsson, Gísli Víkingsson, Paul R. Wade, Rob Williams and Alexandre N.
182186
Zerbini (NA). mmrefpoints: Project Marine Mammal Populations and Calculate Reference Points. R package version 0.1.6.
183-
url: <https://github.com/mcsiple/mmrefpoints> doi: 10.5281/zenodo.4758402
187+
url: <https://github.com/mcsiple/mmrefpoints> doi: 10.5281/zenodo.4758401
188+
189+
NOTE that if you want to cite all versions of the software, you can use the doi [10.5281/zenodo.4758401](https://zenodo.org/record/5949332#.Yf1infXMI-Q). When additional releases happen, there will be a doi for each new release as well.

README.md

+16-8
Original file line numberDiff line numberDiff line change
@@ -81,14 +81,16 @@ This package can be downloaded directly from GitHub:
8181
### Community guidelines
8282

8383
We would like this package to be sustainable in the long term and
84-
welcome contributions. If you encounter a bug, please leave a note on
85-
the [Issues page](https://github.com/mcsiple/mmrefpoints/issues). You
86-
can also leave comments there about additional functionality (please add
87-
the “enhancement” label to your issue).
84+
welcome contributions. If you are interested in contributing, please
85+
check out our [Contribution
86+
Guide](https://github.com/mcsiple/mmrefpoints/blob/master/CONTRIBUTING.md).
8887

89-
If you are interested in contributing, we direct you to the R package
90-
[contribution advice](http://r-pkgs.had.co.nz/git.html) from Hadley
91-
Wickham.
88+
Bugs and enhancements are tracked through GitHub issues. If you have a
89+
bug to report, there is a [bug report
90+
template](https://github.com/mcsiple/mmrefpoints/blob/master/.github/ISSUE_TEMPLATE/bug_report.md)
91+
to help maximize the benefit of your report for everyone. The same goes
92+
for requests for
93+
[enhancements](https://github.com/mcsiple/mmrefpoints/blob/master/.github/ISSUE_TEMPLATE/feature_request.md).
9294

9395
## Accessing the MMBIET Shiny app
9496

@@ -222,4 +224,10 @@ citation:
222224
> Wade, Rob Williams and Alexandre N. Zerbini (NA). mmrefpoints: Project
223225
> Marine Mammal Populations and Calculate Reference Points. R package
224226
> version 0.1.6. url: <https://github.com/mcsiple/mmrefpoints> doi:
225-
> 10.5281/zenodo.4758402
227+
> 10.5281/zenodo.4758401
228+
229+
NOTE that if you want to cite all versions of the software, you can use
230+
the doi
231+
[10.5281/zenodo.4758401](https://zenodo.org/record/5949332#.Yf1infXMI-Q).
232+
When additional releases happen, there will be a doi for each new
233+
release as well.

0 commit comments

Comments
 (0)