Updating guides

Guides is a living document that is continually edited and updated. As the time goes by we may discover:

• Different practices that may be better than those currently described in guides.
• Practices that are not yet described in guides.
• Old practices described in guides that are no longer being used.

If anything like that happens it is important to update our guides to reflect the actual situation. This section defines a protocol of how to deal with such cases.

A different practice has been discovered

If any member of the team discovers a different and potentially better approach, the team member should:

• Call for a vote to find out if this different approach is better.
• If it is decided that the new approach is not better, developer should follow current approach and update the code according to rules described in guides.
• If it is decided that the approach is better:
  • New story is created in Redmine Guides project.
  • Guides are updated.
  • Changes are presented during brown bag presentation.

Practices that are not yet covered in Guides are discovered

If any member of the team discovers that some practice has not been added to the guides yet, the team member should:

• Create a new story in Redmine Guides project.
• Update Guides in a feature branch.
• Present changes during brown bag presentation.

As soon as the story in Redmine Guides project is created the practice becomes valid and should be used by the team.

Old practice described in guides is no longer relevant

If any member of the team discovers that some rule described in guides is no longer relevant, the team member should:

• Call for a vote to find out if guides need to be changed.
• If it is decided that guides do not need an update, no action is needed.
• If it is decided that guides need to be updated:
  • New story is created in Redmine Guides project.
  • Guides are updated.
  • Changes are presented during brown bag presentation.
  • Team collectively approves or disapproves the change.