From 20e3612b137d02c772a76788ba6303a59e5e18f4 Mon Sep 17 00:00:00 2001 From: Aidan Montare Date: Wed, 19 Jun 2024 19:33:12 -0600 Subject: [PATCH 1/3] begin CONTRIBUTING.md --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..be32a2bb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +# 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 +- 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. + + +## Contributing code + +Code changes can be contributed by opening a pull request. + + +### Development process + + +### Pull request guidelines + + +### Development environment From 4eef147d9999c7de41b6092c1e62669958f31091 Mon Sep 17 00:00:00 2001 From: Aidan Montare Date: Wed, 19 Jun 2024 20:53:04 -0600 Subject: [PATCH 2/3] add more outline to contributing guide --- CONTRIBUTING.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index be32a2bb..c4b5cc6a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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). From 6243d26aa29a319eb6dd629ceb00a89fb24d8e63 Mon Sep 17 00:00:00 2001 From: Aidan Montare <47719225+aidanmontare-edu@users.noreply.github.com> Date: Thu, 20 Jun 2024 18:05:03 -0600 Subject: [PATCH 3/3] Update CONTRIBUTING.md Co-authored-by: Michael Atkinson --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c4b5cc6a..96d4588b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,9 @@ Anyone can add to the scoreboard wiki pages, so if you see an area that doesn't ## 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