Skip to content

Commit a263a98

Browse files
committed
add more outline to contributing guide
1 parent f34b117 commit a263a98

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

CONTRIBUTING.md

+20-8
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,10 @@
11
# Contributing to CRG ScoreBoard
22

33

4-
This page is currently a draft.
5-
6-
7-
***
8-
94

105
CRG Scoreboard is created by the community, and welcomes contributions of all kinds. Some areas that we especially appreciate contributions in are:
116

12-
- improvements to these wiki pages
7+
- improvements to the wiki pages
138
- reporting issues and unexpected behavior
149
- testing
1510
- new or improved technical documentation
@@ -20,15 +15,32 @@ CRG Scoreboard is created by the community, and welcomes contributions of all ki
2015
Anyone can add to the scoreboard wiki pages, so if you see an area that doesn't have much documentation, we encourage you to add it! If you are unsure about your changes or would like feedback before editing the wiki, feel free to open an issue to discuss it.
2116

2217

18+
## Reporting issues
19+
20+
You can report issues with the scoreboard software or its documentation via [our issues page](https://github.com/rollerderby/scoreboard/issues). This is also the best place to ask questions or reach out to the developers.
21+
22+
23+
## Contributing to testing
24+
25+
2326
## Contributing code
2427

2528
Code changes can be contributed by opening a pull request.
2629

2730

28-
### Development process
31+
### Pull request guidelines
2932

3033

31-
### Pull request guidelines
34+
### Development process
3235

3336

3437
### Development environment
38+
39+
For suggestions on setting up a development environment, see [our developer guide](https://github.com/rollerderby/scoreboard/wiki/Developer-Guide).
40+
41+
42+
## Contributing technical documentation
43+
44+
The wiki has a section for [developer information](https://github.com/rollerderby/scoreboard/wiki#developer-information), and additions are welcome!
45+
46+
If you are a new contributor to the scoreboard, your observations of what isn't obvious or needs documentation is very valuable. You can give feedback by [opening an issue](https://github.com/rollerderby/scoreboard/issues/new).

0 commit comments

Comments
 (0)