1
- # Contributing to ` github `
1
+ # Contributing to ` repometrics `
2
2
3
3
<!-- This CONTRIBUTING.md is adapted from https://gist.github.com/peterdesmet/e90a1b0dc17af6c12daf6e8b2f044e7c -->
4
4
5
- First of all, thanks for considering contributing to ` githist ` ! 👍 It's
5
+ First of all, thanks for considering contributing to ` repometrics ` ! 👍 It's
6
6
people like you that make it rewarding for us - the project maintainers - to
7
- work on ` githist ` . 😊
7
+ work on ` repometrics ` . 😊
8
8
9
- ` githist ` is an open source project, maintained by people who care.
9
+ ` repometrics ` is an open source project, maintained by people who care.
10
10
11
11
- repo: https://github.com/ropensci-review-tools/githist
12
12
- issues: https://github.com/ropensci-review-tools/githist/issues
@@ -29,15 +29,15 @@ this [Open Source Guide](https://opensource.guide/how-to-contribute/).
29
29
30
30
### Share the love ❤️
31
31
32
- Think ` githist ` is useful? Let others discover it, by telling them in person,
32
+ Think ` repometrics ` is useful? Let others discover it, by telling them in person,
33
33
via Twitter or a blog post.
34
34
35
- Using ` githist ` for a paper you are writing? Consider [ citing
35
+ Using ` repometrics ` for a paper you are writing? Consider [ citing
36
36
it] ( https://github.com/ropensci-review-tools/githist/blob/main/inst/CITATION ) .
37
37
38
38
### Ask a question ⁉️
39
39
40
- Using ` githist ` and got stuck? [ Browse the
40
+ Using ` repometrics ` and got stuck? [ Browse the
41
41
documentation] ( https://docs.ropensci.org/githist/ ) to see if you can find a
42
42
solution. Still stuck? Post your question as an [ issue on
43
43
GitHub] ( https://github.com/ropensci-review-tools/githist/issues ) . While we
@@ -49,7 +49,7 @@ Want to ask a question in private? Contact the package maintainer by
49
49
50
50
### Propose an idea 💡
51
51
52
- Have an idea for a new ` githist ` feature? Take a look at [ the
52
+ Have an idea for a new ` repometrics ` feature? Take a look at [ the
53
53
documentation] ( https://docs.ropensci.org/githist/ ) and [ issues
54
54
list] ( https://github.com/ropensci-review-tools/githist/issues ) to see if it
55
55
isn't included or suggested yet. If not, suggest your idea as an [ issue on
@@ -63,17 +63,17 @@ See below if you want to contribute code for your idea as well.
63
63
64
64
### Report a bug 🐛
65
65
66
- Using ` githist ` and discovered a bug? That's annoying! Don't let others have
66
+ Using ` repometrics ` and discovered a bug? That's annoying! Don't let others have
67
67
the same experience and report it as an [ issue on
68
68
GitHub] ( https://github.com/ropensci-review-tools/githist/issues/new ) so we can
69
69
fix it. A good bug report makes it easier for us to do so, so please:
70
70
71
71
- Use [ the ` reprex ` package] ( https://reprex.tidyverse.org ) to create a
72
72
reproducible example.
73
- - Include the version of ` githist ` with the following line in your ` reprex `
73
+ - Include the version of ` repometrics ` with the following line in your ` reprex `
74
74
code:
75
75
```
76
- packageVersion("githist ")
76
+ packageVersion("repometrics ")
77
77
```
78
78
79
79
### Improve the documentation 📖
@@ -111,7 +111,7 @@ want to improve a function description:
111
111
112
112
### Contribute code 📝
113
113
114
- Care to fix bugs or implement new functionality for ` githist ` ? Awesome! 👏
114
+ Care to fix bugs or implement new functionality for ` repometrics ` ? Awesome! 👏
115
115
Have a look at the [ issue
116
116
list] ( https://github.com/ropensci-review-tools/githist/issues ) and leave a
117
117
comment on the things you want to work on. See also the development guidelines
@@ -141,11 +141,11 @@ flow](https://guides.github.com/introduction/flow/) for development.
141
141
142
142
## Code style
143
143
144
- The ` githist ` coding style diverges somewhat from [ the commonly used tidyverse
144
+ The ` repometrics ` coding style diverges somewhat from [ the commonly used tidyverse
145
145
style guide] ( https://style.tidyverse.org/syntax.html#spacing ) , primarily
146
146
through judicious use of
147
147
whitespace, which aims to improve code readability. Code references in
148
- ` githist ` are separated by whitespace, just like words of text. Just like it
148
+ ` repometrics ` are separated by whitespace, just like words of text. Just like it
149
149
is easier to understand "these three words" than "thesethreewords", code is
150
150
formatted like this:
151
151
@@ -165,7 +165,7 @@ The position of brackets is then arbitrary, and we could also write
165
165
these <- three( words (x ))
166
166
```
167
167
168
- ` githist ` code opts for the former style, with the natural result that one
168
+ ` repometrics ` code opts for the former style, with the natural result that one
169
169
ends up writing
170
170
171
171
``` r
0 commit comments