diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..96d4588b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,48 @@ +# Contributing to CRG ScoreBoard + + + +CRG Scoreboard is created by the community, and welcomes contributions of all kinds. Some areas that we especially appreciate contributions in are: + +- improvements to the wiki pages +- reporting issues and unexpected behavior +- testing +- new or improved technical documentation + + +## Contributing to the wiki + +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. +Before posting an issue, check to see whether the issue is being discussed already. + +When [creating a new issue](https://github.com/rollerderby/scoreboard/issues/new/choose), choose the template that best represents what you are looking to report, and fill out all applicable fields. + +## Contributing to testing + + +## Contributing code + +Code changes can be contributed by opening a pull request. + + +### 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).