Skip to content

Commit 5c8b27c

Browse files
Merge pull request #12 from r-devel/README
updated README
2 parents 3f6b3b6 + d293f4c commit 5c8b27c

File tree

2 files changed

+29
-9
lines changed

2 files changed

+29
-9
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,8 +127,8 @@ which everyone is welcome to join.
127127

128128
## Acknowledgements
129129

130-
This contributing guide was adpated from the CONTRIBUTING.md file of
131-
[The Carpentries Workbench][carpentries-workbench] template, which is
130+
This contributing guide was adapted from the CONTRIBUTING.md file of
131+
[The Carpentries Workbench][workbench] template, which is
132132
Copyright © [Software Carpentry][swc-site]
133133
under a [CC BY 4.0][cc-by-human] license.
134134

@@ -144,4 +144,5 @@ under a [CC BY 4.0][cc-by-human] license.
144144
[slack]: https://contributor.r-project.org/slack
145145
[swc-site]: http://software-carpentry.org/
146146
[twitter]: https://twitter.com/R_Contributors
147+
[workbench]: https://carpentries.github.io/sandpaper-docs/
147148

README.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,30 @@
1-
# The Carpentries Workbench Template R Markdown Lesson
1+
# Lesson on R's Bug Tracking Process
22
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
33
[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
44
<!-- ALL-CONTRIBUTORS-BADGE:END -->
55

66
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-1.2-0baaaa.svg)](code_of_conduct.md)
77

8-
This lesson is a template lesson that uses [The Carpentries Workbench][workbench].
8+
This lesson introduces the bug tracking process used by [the R project][r].
9+
It is intended for people that are completely new to this topic,
10+
to help them understand ways in which they can contribute.
11+
Although it is aimed at R users, it may be of interest to potential contributors to other software projects that use [Bugzilla][bugzilla].
912

10-
To get started using this template, visit https://github.com/carpentries/workbench-template-rmd/generate
11-
and follow the instructions.
13+
The lesson was originally delivered as two [Collaboration Campfire][campfire] sessions.
14+
We hope that this material will be helpful for people that would like to
15+
run a similar session in future, or potential contributors that would like to
16+
go through the material themselves.
1217

13-
If you have any questions, contact [@zkamvar](https://github.com/zkamvar)
18+
## Acknowledgements
1419

15-
[workbench]: https://carpentries.github.io/sandpaper-docs/
20+
This lesson uses the website [template][template] from [The Carpentries Workbench][workbench], which is
21+
Copyright © [Software Carpentry][swc-site]
22+
under a [CC BY 4.0][cc-by-human] license. We have made changes to reflect that this is a R Contribution Working Group project, rather than a Carpentries project.
23+
24+
The Collaboration Campfires were organized as part of the project [Building Community around the R Development Guide](https://incubator.codeforscience.org/cohort), lead by Saranjeet Kaur and Heather Turner, which was supported by the Digital Infrastructure Incubator at [Code for Science & Society (CS&S)](https://codeforscience.org/). The project benefited from the input of community champions from groups such as R-Ladies and members of the R Contribution Working Group.
25+
26+
The first draft of this lesson was developed on the Hack Day as part of
27+
[Collaborations Workshop 2022](https://software.ac.uk/cw22).
1628

1729
## Contributors ✨
1830

@@ -34,4 +46,11 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
3446

3547
<!-- ALL-CONTRIBUTORS-LIST:END -->
3648

37-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
49+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
50+
51+
[campfire]: https://contributor.r-project.org/events/collaboration-campfires
52+
[bugzilla]: https://www.bugzilla.org/
53+
[r]: https://www.r-project.org/
54+
[template]: https://github.com/carpentries/workbench-template-rmd
55+
[workbench]: https://carpentries.github.io/sandpaper-docs/
56+
[workbench]: https://carpentries.github.io/sandpaper-docs/

0 commit comments

Comments
 (0)