PR Policy for DApps of POA Network

[igorbarinov]

Title

  Title: Generic PR Policy for DApps of POA Network
  Layer: Project Management

Abstract

In this RFC we propose a PR policy for contributors and developers of DApps in POA Network.

Rationale

At the moment, the PR policy is implemented in ICO Wizard DApp. It helps manage processes with the distributed team. In this proposal, we generalize and summarize PR police

Specification

Each PR should have:

• Mandatory Description
  a human-readable description of changes
  a human-readable description of the purpose of the PR
• Recommended What is it: (Fix), (Feature), or (Refactor) in Title, e.g., "(Fix) price of 1 token in Wei > 18 decimals"
• Recommended Developers: Each completed PR should be updated in the Wiki Documentation.
• Recommended Each PR should have one commit message and therefore should only contain one specific fix or feature. Otherwise, multiple PRs should be made
• Optional Any additional concerns or comments

Security

• All DApps should have protected branches for production dapps e.g.Core
  • protected branch should have "Protect this branch", "Require pull request reviews before merging", "Include administrators" options enabled

[afck]

I'm not sure about the third bullet point; there are many PRs that don't really fit one of those categories. Even with e.g. the Leaf guidelines, my experience was that often changes wouldn't fit in one of their eight categories.

Would it make sense to also make this "Recommended" instead, and/or allow using other keywords?

[igorbarinov]

good idea!
Changed to Recommended .. anyway no one rejected PRs for missing this bullet point requirement 😬

[afck]

Another topic we could include in such a document is which reviewer(s) to pick and when to merge.

• Should external contributors try to pick a reviewer or wait for the team to assign one?
• Should team members assign several reviewers, or is it better to pick one (and maybe cc others)?
• In a PR with several reviewers, can you merge with one approval or should you wait until they all approved?