Skip to content

Maintainer Guidelines

AYAN BISWAS edited this page Mar 9, 2021 · 9 revisions

Guidelines

Make sure contributors are respecting the Contribution Guidelines. If they don't let them know about it: what is missing, what was disrespected?

Setup the project locally

You can get the detailed process for setting the project locally here please follow them and setup the project locally

Code Review

  • If you are first reviewer of any PR please leave your review message and if anything work needed from the developer please describe that properly and label it as PR:Work Needed and if it is fine just approve the request
  • If you are the second reviewer of any PR then if the PR is fine and ready to be merged please give a label PR:Approved
  • When possible get a second opinion before merging.
  • If you can, let them know why your change request makes sense.
  • (nice to have) If you have time, thank them for contributing to the project.
  • Make sure that, if the PR changes actual code, to properly test it or wait for someone to confirm the behavior
  • If any PR is opened by you for any reason please label it as maintainer and wait for 2 reviews and don't forget to mention @ayan-bioswas0412 in the comment if any fatal thing happens

Opening new issues

  • If you are opening new issues please strictly follow the issue templates for various needs , if you find that there is a continuous need for another type of template then please raise that issue also
  • Label the issues properly there is three difficulty levels please mark them appropriately
  • If the issue is a part of any open source programme please label that also

Merging PRs (Do this by every Sunday 00:00 hrs)

  • Minimum 2 approvals are needed to validate a PR
  • Please create a branch checkouting from updated main branch git checkout -b 'release/[dd/mm]'
  • Pull all the PRs (only the PRs with PR:Approved Label) and test them thoroughly
  • After pulling all the above mentioned PRs test them finally
  • Add and Commit the PRs
   git commit -m 'mergeable PRs till dd/mm'
  • Push them to git git push origin 'release/[dd/mm]'
  • Make me reviewer @ayan-biswas0412
  • Add labels enhancement and release

Merging will be done every Monday at 00:00 Hrs (If any open source programme's last contribution day is other than Monday then we will merge on that day as specified)