As per various threads on the devel list, we should consider renaming RTBC to "Ready for committer review" to ensure that developer expectations more clearly match reality.

Sounds reasonable, but wow, is there going to be a lot of stale references to "RTBC" on d.o. :( Guess we'll all have to get used to "RFCR" instead.

I don't suppose any brilliant wordsmiths can come up with a new phrase with the right meaning that retains the acronym, huh? ;)

CommentFileSizeAuthor
#30 rtbc.patch1.37 KBchx
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

killes@www.drop.org’s picture

I support this, but let's wait for a day or two if somebody comes up with a better suggestion.

AjK’s picture

Weak start but....

  • Ready To Be Considered
  • Reviews To Be Considered
Anonymous’s picture

To Be Considered by whom? Ready For Committer Review states exactly what is to happen next. We might wish to add another status level to add a buffer before the RFCR status but that is a different issue.

AjK’s picture

As dww said, I was trying to come up with something that matched the existing RTBC so that the zillion posts and articles that already use RTBC still have "meaning".

dww’s picture

"Ready To Be Considered For Commit"? ;) "RTBC(FC)" -- not ideal, for sure.

Yes, this is mostly idle chat. Just wanted to see if anyone had a brilliant idea that retained the acronym. Seems unlikely. So, some "acronym rot" will probably be required, and we'll just have to use RFCR or something more appropriate for the meaning, which ultimately is the most important thing.

JohnAlbin’s picture

patch (needs Review Trusted By Committers)
patch (Request for Thoughts By Committers)
patch (Reviewed Thoroughly, Baby! Commit!) (j/k)
patch (Reviewed Thoroughly, Bidding Committers)
patch (Reviewed, needs Testing By Committers)
patch (Requesting Test By Committers)
patch (Requires Testing By Committers)

The last two hit the acronym perfectly, but don’t implicitly describe where they fall in the workflow. (i.e. if I just wrote a patch, can I get the committers to test it?) The ones that start with ”Reviewed, …” show the workflow better.

Perhaps, “patch (reviewed, Requesting Trial By Committers)”?

drewish’s picture

we don't concern ourselves with breaking backwards compatibility with apis so why should we worry about our issue status names ;) RFCR!

catch’s picture

Ready for Committer Review sounds great to me.

alpritt’s picture

As far as I can tell there were two main problems this development cycle:

1. Feedback for some patches came too late after too much work was done (this is why we are considering something along the lines of a 'concept needs review' status)

2. Most people are trying to rush patches through by saying they are ready to be committed before they are properly tested. And, worse, once they they are set as ready, being reluctant to set back (even when they raise an issue).

The new terminology will not help people be more stern with their reviews. And it will not encourage people to look at patches after they are set to their 'ready for committer review' status. In fact I'd argue this could make that issue worse, since we are referring to the committers to the exclusion of everyone else.

The thing that is more likely to improve these issues is the fact that we have had that dev list discussion and hopefully the culture has changed slightly as a result. I believe Eaton, for example, said he was going to start being harsher with his reviews. This attitude will filter down and become part of the culture of how things are done. Your actions as leaders in the queues will have a much bigger impact than the changing of a few words.

It is your actions and responses that set the expectations.

It doesn't matter what you decide to change it to, 4 words will always be misinterpreted.

-1

JohnAlbin’s picture

Alan, the 2 issues you mention are, indeed, important problems in the latest development cycle. Please look at http://groups.drupal.org/node/4970 where there is a more general discussion about proposed fixes for core development issues.

This thread doesn’t attempt to address the 2 issues you mention. It’s simply trying to re-align developers expectations as to what happens when something is marked RTBC. The “Ready to Be Committed” wording leads to too many assumptions on relatively-new contributors. “Ready for committer review” (or something like it) better explains the process to those contributors.

As for your relevant comment that this change…

…will not encourage people to look at patches after they are set to their 'ready for committer review' status. In fact I'd argue this could make that issue worse, since we are referring to the committers to the exclusion of everyone else.

That’s probably true. Instead of “Ready for Committer Review” should we use “Ready for Final Review”? That might make it clearer that everyone (and not just a committer) is welcome to give it a review.

alpritt’s picture

My point is really that this seems like a non-issue to me. Patches get marked ready to be committed because someone thinks they are ready to be committed. The wording, as far as I can tell is perfectly accurate. Sure newcomers may misinterpret it, but they will misinterpret any wording you choose. That's what happens when you only have half a sentence to explain something. Newcomers just need to spend a little time getting acquainted with the system. This is why we have now added a section to the handbook explaining how all this works.

So,

I don't believe this will relieve any confusion for newcomers.

I do believe this will create some short-term confusion for people who already know the system.

Anonymous’s picture

@alpritt: Speaking as a ``newcomer'' since RTBC doesn't reflect the POV that the committer has the final say and doesn't sit well with ``newcomer'' commitment to Drupal development when the ``newcomer'' sees RTBC as everything is ready for the committer to just commit the patch and then all of a sudden it now becomes PNW. This will even be true with the documentation you have pointed to because READY TO BE COMMITTED has a specific defined meaning with regard to the connotative value within the language. Feelings become hurt, arguments come about on the list and this recommendation is aimed to help prevent that. READY FOR COMMITTER REVIEW has connotative value in describing exactly that some person with commit privilege will make a final review and either commit the patch or mark the path with PNW giving insightful reasons.

@JohnAlbin: ``Ready for Final Review'' gives a connotative meaning that someone will give a final review before doing something else. The something else isn't specified but can be assumed to be either commit the patch or mark it as PNW. I can support this phrasing if it helps with moving this forward to change; although, my preference is ``Ready for Committer Review''.

alpritt’s picture

"Feelings become hurt, arguments come about on the list and this recommendation is aimed to help prevent that."

This is why I brought up the two issues in comment #9. Those seem to be the cause of confusion and hurt feelings... not this. I just haven't seen any evidence that there is a causal link between the current wording and any problems.

I've already raised an issue with 'ready for committer review'. There is another critique about an alternate 'ready for final review'. And I think there will be problems with whatever wording we choose.

JohnAlbin’s picture

I just haven't seen any evidence that there is a causal link between the current wording and any problems.

Alan, the consensus on the devel list was that RTBC does need to be renamed. I invite you to read the “RTBC - how does it work?” thread on http://lists.drupal.org/pipermail/development/2007-July/thread.html Let’s not rehash the argument in this thread.

‘Ready for Final Review’ gives a connotative meaning that someone will give a final review before doing something else. The something else isn't specified but can be assumed to be either commit the patch or mark it as PNW.

Earnie, introducing a little uncertainty into the wording should be fine; making it more likely that newcomers will look up the meaning of RFFR would be a GOOD thing.

Thinking on this some more, improving the (necessarily-short) wording of the issue states is a good idea, but having a full description of the issue states readily available would be a really, REALLY good idea. The best thing would be a #description inside the Issue Information fieldset that links to the meaning of all the statuses and the Drupal development process. For example:

Descriptions of the Priority and Status levels can be found in the Contributing to Development Handbook.

Since the “submission guidelines” feature isn‘t exactly what I’m describing, I’ve added a feature request in the project_issue module (#159457) What do others think of this?

Getting back to this specific proposal, I prefer “Ready for Final Review” since it doesn‘t refer to the committers to the exclusion of everyone else. But “Ready for Committer Review” is still way better than RTBC.

catch’s picture

Getting back to this specific proposal, I prefer “Ready for Final Review” since it doesn‘t refer to the committers to the exclusion of everyone else. But “Ready for Committer Review”

I think I prefer "Ready for Final Review" as well (although both are an improvement).

Sometimes patches that need work or concepts that need approval have already had a review from a committer.

Ready for Final Review suggests that the patch has stabilised and is ready for a final once over, not just by a committer. It's a good indication of the status of the patch, and again it suggests that it'll either get committed or be set to PCNW - which is what actually happens to most RTBC patches (and will hopefully happen quicker in both directions as things move forward).

sun’s picture

Title: Rename "RTBC" to "Ready for committer review" » Rename issue status "RTBC"

This renaming is indeed badly needed. I really like JohnAlbin's proposals in #6. However, I'd suggest to clarify:

- We want neither not-yet-reviewed nor untested patches to be set to RTBC.
- Developers should only set RTBC if at least one other developer reviewed and tested a patch.
- RTBC is the last step in the workflow in front of committing a patch.

So, I would propose this:

patch (code needs review)
patch (code needs work)
patch (reviewed and tested by others)

Thus, RTBC would become RTBO and that status is totally clear to everyone.

Note: patch (reviewed & tested by others) would be cleaner, but AFAIK project_issue does not support ampersands.

anders.fajerson’s picture

If we went with "reviewed & tested by others" we might consider "reviewed & tested by communtity" (RTBC) :) Although core commiters are certainly part of the community... Maybe too creative.

chx’s picture

"reviewed & tested by communtity" i like this one a lot , as it reflects , very nicely, what status the issue should be in.

Anonymous’s picture

And how many reviewers and testers does it take to move it to "By Community"? Should we not have a poll attached to the file that gives a meaning toward how many reviews were accomplished for that file? One issue can have many patches but the RTBC needs love for the one file.

sun’s picture

Status: Active » Needs review

Another +1 for "reviewed & tested by communtity".

@earnie: Attaching polls/votes to file attachments is something to consider for D8 and beyond... anyway, that's not the point of this issue.

I don't think we need hard numbers here. "Community" is plural already. Thus, from my understanding it would indicate that a patch needs to be reviewed AND tested by at least two contributors.
Furthermore, when submitting a patch in a new issue, I would not "be able" to set the issue status to RTBC, because *I know* it hasn't been reviewed, nor tested by anyone else. And that's one of the points of this issue.

colan’s picture

+1 for "reviewed & tested by community"...

...but shouldn't we still have "ready to be committed"? I'm thinking about my contrib modules, and I think it would work the same way in core. If a committer type reviews something after "reviewed & tested by community", couldn't it move to another state before being committed? I'm just thinking of the times I've reviewed something, liked it, but wasn't planning on committing it just yet. So maybe what we want to do here is add a new status instead of renaming an existing one.

In other words, ""reviewed & tested by community" would be the status before ""ready to be committed". The problem then, of course, would be that one of those acronyms would have to change. ;)

catch’s picture

//Thus, from my understanding it would indicate that a patch needs to be reviewed AND tested by at least two contributors.

That's how I understand it as well. And a poll doesn't say this IMO. Meaningful comments in followups do.

Another +1 from me.

catch’s picture

Cross posted with colan, but that's a good point about contrib. Could we rename all current RTBC issues to "Reviewed and tested by community" then make a new status "To be committed" which is only available to users with cvs access to a project? I don't know how the permissions work on this (probably not like that though).

JohnAlbin’s picture

Status: Needs review » Reviewed & tested by the community

I agree. “reviewed & tested by community” fits very nicely. Thanks for the suggestion, Anders!

Ok. Given that we’ve got 3 reviews of Anders’ suggestion, I’m marking this RTBC.

These docs will need updating after the change: http://drupal.org/node/156119

JohnAlbin’s picture

Could we rename all current RTBC issues to "Reviewed and tested by community" then make a new status "To be committed" which is only available to users with cvs access to a project?

If only users with cvs access can set it to "to be committed". Why not just commit it and mark it “fixed”? :-)

@colan, is the list of RTBC issues so long in your contrib module that you need a separate status just to track the ones you want to commit, but later? You can just post a comment saying "I'll commit this soon."

catch’s picture

JohnAlbin - yeah good point. I see very few RTBC patches in contrib so it's perhaps not much of an issue.

sun’s picture

ouch! Do we have a string limit here? I only see "patch (reviewed and tested by co" :-/

JohnAlbin’s picture

Status: Reviewed & tested by the community » Needs work

“patch (reviewed and tested by co” is 32 characters.

Anybody want to write a patch to increase the limit? :-)

chx’s picture

Aaand... action!

chx’s picture

Project: Drupal.org site moderators » Project issue tracking
Version: » 5.x-1.3
Component: Site organization » Issues
Status: Needs work » Needs review
FileSize
1.37 KB

Doh.

webchick’s picture

Project: Project issue tracking » Drupal.org site moderators
Version: 5.x-1.3 »
Component: Issues » Site organization
Status: Needs review » Needs work
webchick’s picture

Oops. Too late. :D

webchick’s picture

Project: Drupal.org site moderators » Project issue tracking
Version: » 5.x-2.x-dev
Component: Site organization » Issues
Status: Needs work » Needs review

Sigh. ;) Resetting all statuses.

chx’s picture

Version: 5.x-2.x-dev » 5.x-1.x-dev
aclight’s picture

Project: Project issue tracking » Drupal.org site moderators
Version: 5.x-1.x-dev »
Component: Issues » Site organization

Personally, I don't think #224986: Make issue status field longer should have been marked as a duplicate, because the length of the status field is a project_issue problem, but the name of the status really belongs in the webmasters queue, unless the proposal is that the project issue module itself should change the name of that status, which I don't think is a good idea.

Since the patch here only addresses the length of the status field, I'm re-opening #224986: Make issue status field longer and moving this back to the webmasters queue.

chx’s picture

Status: Needs review » Fixed
JohnAlbin’s picture

http://drupal.org/node/156119 has been updated with new RTBC definition. yay!

I still think putting a link to the Priority and Status definitions inside the “Edit issue settings” fieldset is a good idea. Feature request: http://drupal.org/node/159457

For example:

Descriptions of the Priority and Status levels can be found in the Contributing to Development Handbook.

Anonymous’s picture

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for two weeks with no activity.