Skip to content

Guidelines: maintainer conduct

RussKie edited this page Jan 6, 2019 · 5 revisions

Issues

  • Ensure the issue template is correctly filled and necessary information (such as app info, clear problem statement, steps to reproduce etc) is provided. If not, politely ask the author to supply necessary information.
  • Triage issue and label it accordingly - whether the requested is a bug or a feature. Consider whether the issue is a regression.

Pull Requests

Tagging:

  • Mark PRs which you believe are ready with the Ready tag
  • If no one else has comments or feedback for those, merge them
  • Remove the Ready tag once merged

Milestones:

  • If a PR fixes an issue - add the issue to a milestone
  • If the PR isn't attached to an issue, add the PR to a milestone instead

For example, the next milestone is 3.0. If a bug needs to be back-patched, add it to the 3.0+2.5x milestone and submit a fix to the release/2.5x branch.

Milestones

  • Create a version milestone for each planned release.
  • Add issues to a version milestone that should be resolved before the version can be released. Issues can be moved to a next release or removed from a milestone at all. It is nice to give a short explanation for such a change.
  • Add resolved issues to a version milestone that the version includes the fix for the issue.
  • Only when a merged PR does not have a describing issue, then add the PR to a version milestone the same way as fixed issues. Otherwise add the describing issue to a version milestone.
  • Each Issue/PR assigned to a milestone should be labeled either as a bug or a feature-request.