diff options
Diffstat (limited to 'docs/markdown/Wrap-review-guidelines.md')
| -rw-r--r-- | docs/markdown/Wrap-review-guidelines.md | 42 |
1 files changed, 27 insertions, 15 deletions
diff --git a/docs/markdown/Wrap-review-guidelines.md b/docs/markdown/Wrap-review-guidelines.md index 512353c..3e41a8d 100644 --- a/docs/markdown/Wrap-review-guidelines.md +++ b/docs/markdown/Wrap-review-guidelines.md @@ -7,18 +7,30 @@ package is rejected. What should be done will be determined on a case-by-case basis. Similarly meeting all these requirements does not guarantee that the package will get accepted. Use common sense. -## Checklist - -Reviewer: copy-paste this to MR discussion box and tick all boxes that apply. - - - [ ] project() has version string - - [ ] project() has license string - - [ ] if new project, master has tagged commit as only commit - - [ ] if new branch, it is branched from master - - [ ] contains a readme.txt - - [ ] contains an upstream.wrap file - - [ ] download link points to authoritative upstream location - - [ ] wrap repository contains only build system files - - [ ] merge request is pointed to correct target branch (not master) - - [ ] wrap works - - [ ] repo does not have useless top level directory (i.e. libfoobar-1.0.0) +The review process is partially automated by the [mesonwrap](Wrap-maintainer-tools.md) +`review` tool. + +``` +mesonwrap review zlib --pull-request=1 [--approve] +``` + +Since not every check can be automated please pay attention to the following during the review: + +- Download link points to an authoritative upstream location. +- Version branch is created from master. +- Except for the existing code, `LICENSE.build` is mandatory. +- `project()` has a version and it matches the source version. +- `project()` has a license. +- Complex `configure_file()` inputs are documented. + If the file is a copy of a project file make sure it is clear what was changed. +- Unit tests are enabled if the project provides them. +- There are no guidelines if `install()` is a good or a bad thing in wraps. +- If the project can't be tested on the host platform consider using the `--cross-file` flag. + See [the issue](https://github.com/mesonbuild/mesonwrap/issues/125). + +Encourage wrap readability. Use your own judgement. + +## Approval + +If the code looks good use the `--approve` flag to merge it. +The tool automatically creates a release. |