From: Andy Allan Date: Wed, 13 Nov 2024 12:14:29 +0000 (+0000) Subject: Add note on assigning issues X-Git-Tag: live~81^2 X-Git-Url: https://git.openstreetmap.org./rails.git/commitdiff_plain/c54ad72f93232370a223e88509d1f1be68bf1ddc Add note on assigning issues New users are encouraged by Github to read the CONTRIBUTING file, so that's where it's worth putting it. The explanation of why can be put elsewhere. --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2571b9345..a6456bec1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,13 @@ * https://www.ruby-lang.org/ - The homepage of Ruby which has more links and some great tutorials. * https://rubyonrails.org/ - The homepage of Rails, also has links and tutorials. +## Assigning Issues + +We don't assign issues to individual contributors. You are welcome to work on any +issue, and there's no need to ask first. + +For more details see [our FAQ](FAQ.md)] + ## Coding style We use [Rubocop](https://github.com/rubocop-hq/rubocop) (for ruby files) diff --git a/FAQ.md b/FAQ.md index d4ac1fc9f..da473a6b4 100644 --- a/FAQ.md +++ b/FAQ.md @@ -23,3 +23,13 @@ drive. This is a great way to reach a lot of people! See [PR #1296](https://github.com/openstreetmap/openstreetmap-website/pull/1296) as an example. + +## Why don't you assign issues? + +We don't assign issues to volunteers for several reasons. The main reasons are that it discourages other volunteers from working on the issue, and the process turns into an unproductive administrative overhead for our team. + +There's no need to ask for an issue to be assigned before anyone starts working on it. Everyone is welcome to work on any issue at any time. + +In our experience, most people who ask for an issue to be assigned to them never create a pull request. So we would need to keep track of the assigned issues, and remember to unassign them a week or two into the future, when it is likely that they will not be making a PR. Assigned developers might feel bad if they perceive that we're unhappy with their progress, further discouraging them from contributing. Or we will get drawn into discussions about needing more time, or re-assigning them again, or so on. So it is best not to assign in the first place. + +The risk that two people are both genuinely working on the same task in the same hour or two is vanishingly remote, and doesn't outweigh the downsides described above. A better approach is to encourage people to simply work on the task and create a pull request, at which point everyone knows that they are actually working on the issue and not just planning/hoping/wishing to do so.