Github Issue / PR Review Guidelines

tags: guidelines

Organization

• Senior reviewers:
  • who:
    • Members of the core team on Github
  • tasks:
    • Communications in github issues: Contribution Response Templates
    • Final approval issues/PR
    • merging pull requests and different branches into the master
  • Reviewers:
    • who:
      • Members of the Issue / PR Review work group
      • Everyone who has the skills requested to solve the issues
    • tasks:
      • managers and controllers of issues/pull requests(PR)
        • prioritization
        • management
        • maintenance
      • right assignation to right person (ex. bug related to core code to senior members)
      • bug fixing
      • handle of issues / PR
      • doing and making everything to solve the issue(code + contacting the person who raised the issue/PR)
      • submit the issue/PR to a senior reviewer for a final review
        ​

---

Kanban board

---

4 columns:

• To do

  • The list of every issue/PR ready to be evaluated
  • max 15 issues/PRs at time
  • this column is updated manually by Francesco

• In progress

  • The list of every issue/PR where reviewers are working on
  • max 15 issues/PRs at time
  • this column is updated manually by Francesco

• Ready to be merged

  • every PR approved, but not merged, will be moved here automatically

• Done

  • every issue/PR closed will be moved here automatically

---

Weekly call

---

Date: every Wednesday
Time: 4:30 to 5:15 pm CEST
Google Meet: Link

Purpose of the weekly call:

​​​​    - alignment 
​​​​    - share information 
​​​​    - ask questions

Important: Please make sure to complete your tasks before the call (e.g. prioritization, solving issues, etc.). This way we can guarante to have a profitable call.

---

Ho to join the review team

---

​
For all information, take a look here: https://github.com/django-cms/django-cms/blob/develop/CONTRIBUTING.rst <https://github.com/django-cms/django-cms/blob/develop/CONTRIBUTING.rst>_
​
Steps
​

1. Create a GitHub account, if you don’t have any
   ​
2. Join us in our django CMS Slack channel <https://www.django-cms.org/slack>_
   ​
3. Send a message to Nicolai Ridani
   ​
4. When you are a member of the review team on GitHub, you can handle issues (assign yourself, set labels, etc.) and solve them.
   ​
5. Attend to weekly calls regularly.
   ​

---

How to assign issues and set labels

---

1. Open an issue
2. On the right column you can see “Assignees” and Labels.
3. Click on each gear button to set Assignees and labels respectively

• Please start using the label "accepted"

---

PR ready to be merged

---

• If the PR is approved and ready to be merged, please leave a comment for a core team member in the PR as a reminder
• When a issue/PR has been merged, please remove all labels related to "status" and "needs" categories before closing it

---

Message template list for Issues

---

Issue / PR Message template list