Skip to content

Commit 2ee894b

Browse files
committed
refactor: improve contributing guidelines
1 parent ce1bdf8 commit 2ee894b

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
We love your input! 🚀 We want to make contributing to this project as easy and transparent as possible, whether it's:
44

5-
- Reporting a bug
6-
- Discussing the current state of the code
7-
- Submitting a fix
8-
- Proposing new features
9-
- Becoming a maintainer
5+
- Reporting a bug.
6+
- Discussing the current state of the code.
7+
- Submitting a fix.
8+
- Proposing new features.
9+
- Becoming a maintainer.
1010

1111
## We Develop with Github
1212

@@ -37,13 +37,17 @@ We use GitHub issues to track public bugs. Report a bug by [opening a new issue]
3737

3838
**Great Bug Reports** tend to have:
3939

40-
- A quick summary and/or background
41-
- Steps to reproduce
40+
- A quick summary and/or background.
41+
42+
- Steps to reproduce:
4243
- Be specific!
43-
- Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that _anyone_ with a base R setup can run to reproduce what I was seeing
44-
- What you expected would happen
45-
- What actually happens
46-
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
44+
- Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that _anyone_ with a base R setup can run to reproduce what I was seeing.
45+
46+
- What you expected would happen.
47+
48+
- What actually happens.
49+
50+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work).
4751

4852
People _love_ thorough bug reports. I'm not even kidding.
4953

0 commit comments

Comments
 (0)