Skip to content

Commit

Permalink
add more outline to contributing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
AidanMontare committed Jun 20, 2024
1 parent f34b117 commit a263a98
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,10 @@
# Contributing to CRG ScoreBoard


This page is currently a draft.


***


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

- improvements to these wiki pages
- improvements to the wiki pages
- reporting issues and unexpected behavior
- testing
- new or improved technical documentation
Expand All @@ -20,15 +15,32 @@ CRG Scoreboard is created by the community, and welcomes contributions of all ki
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.


## Reporting issues

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.


## Contributing to testing


## Contributing code

Code changes can be contributed by opening a pull request.


### Development process
### Pull request guidelines


### Pull request guidelines
### Development process


### Development environment

For suggestions on setting up a development environment, see [our developer guide](https://github.com/rollerderby/scoreboard/wiki/Developer-Guide).


## Contributing technical documentation

The wiki has a section for [developer information](https://github.com/rollerderby/scoreboard/wiki#developer-information), and additions are welcome!

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 comments on commit a263a98

Please sign in to comment.