From 3e17ffc52913970e797847944ba210263ea13614 Mon Sep 17 00:00:00 2001 From: Justin W. Flory Date: Feb 25 2019 05:19:35 +0000 Subject: Add maintainer guidelines This commit adds guidelines for maintainers of fedora-happiness-packets. The guidelines document tasks for us to keep things running smoothly and reviewing new changes. This is not a complete document, but I figured we can start with this and add new things in as they come up. But this gives us a base to start with for now. 🌈 --- diff --git a/.project-docs/MAINTAINERS.md b/.project-docs/MAINTAINERS.md new file mode 100644 index 0000000..4213997 --- /dev/null +++ b/.project-docs/MAINTAINERS.md @@ -0,0 +1,30 @@ +Guidelines for maintainers +========================== + +These guidelines are intended for maintainers of fedora-happiness-packets (including Fedora Summer Coding mentors). +Following these guidelines helps us keep things running smoothly. +It also helps us as mentors when we are spread across different schedules and time zones. +Stick to these whenever possible. + + +## Use [![PASSED](/fedora-commops/fedora-happiness-packets/issue/raw/files/d4820df9449fd61951d807b5fe86231092a31db15932759b2b7b810262c002d0-Screenshot_2019-02-24_Settings_-_fedora-commops_fedora-happiness-packets_-_Pagure_io.png)](/fedora-commops/fedora-happiness-packets/issue/raw/files/d4820df9449fd61951d807b5fe86231092a31db15932759b2b7b810262c002d0-Screenshot_2019-02-24_Settings_-_fedora-commops_fedora-happiness-packets_-_Pagure_io.png "PASSED") label to accept tickets for future work. + +The [![PASSED](/fedora-commops/fedora-happiness-packets/issue/raw/files/d4820df9449fd61951d807b5fe86231092a31db15932759b2b7b810262c002d0-Screenshot_2019-02-24_Settings_-_fedora-commops_fedora-happiness-packets_-_Pagure_io.png)](/fedora-commops/fedora-happiness-packets/issue/raw/files/d4820df9449fd61951d807b5fe86231092a31db15932759b2b7b810262c002d0-Screenshot_2019-02-24_Settings_-_fedora-commops_fedora-happiness-packets_-_Pagure_io.png "PASSED") label indicates a ticket passed review by a maintainer. +This means it is accepted as a valid task to work on. +This label is useful during a summer coding application period. +Several people may look for tasks to work on. +Some new tickets may need consideration or triage before they are accepted. +This helps us avoid a creeping scope and trying to do too many things at once. + +Remember our documentation states a person should only work on a ticket with the [![PASSED](/fedora-commops/fedora-happiness-packets/issue/raw/files/d4820df9449fd61951d807b5fe86231092a31db15932759b2b7b810262c002d0-Screenshot_2019-02-24_Settings_-_fedora-commops_fedora-happiness-packets_-_Pagure_io.png)](/fedora-commops/fedora-happiness-packets/issue/raw/files/d4820df9449fd61951d807b5fe86231092a31db15932759b2b7b810262c002d0-Screenshot_2019-02-24_Settings_-_fedora-commops_fedora-happiness-packets_-_Pagure_io.png "PASSED") label. +Not using this label could exclude a ticket from consideration. + + +## Use tags to triage tickets for type of work. + +There are several tags for different types of tickets (e.g. `type - docs`, `type - frontend`, `type-backend`, etc.). +Use these to triage types of work. +It is easier for contributors and maintainers: + +* Contributors can choose tasks in their interest areas +* Maintainers can review changes in their skill area