diff options
Diffstat (limited to '.gitlab/issue_templates')
| -rw-r--r-- | .gitlab/issue_templates/Database Reviewer.md | 34 | ||||
| -rw-r--r-- | .gitlab/issue_templates/Documentation.md | 2 | ||||
| -rw-r--r-- | .gitlab/issue_templates/Feature proposal.md | 32 | ||||
| -rw-r--r-- | .gitlab/issue_templates/Refactoring.md | 41 | ||||
| -rw-r--r-- | .gitlab/issue_templates/Test plan.md | 2 |
5 files changed, 84 insertions, 27 deletions
diff --git a/.gitlab/issue_templates/Database Reviewer.md b/.gitlab/issue_templates/Database Reviewer.md new file mode 100644 index 00000000000..acbaf5c1965 --- /dev/null +++ b/.gitlab/issue_templates/Database Reviewer.md @@ -0,0 +1,34 @@ +#### Database Reviewer Checklist + +Thank you for becoming a ~database reviewer! Please work on the list +below to complete your setup. For any question, reach out to #database +an mention `@abrandl`. + +- [ ] Change issue title to include your name: `Database Reviewer Checklist: Your Name` +- [ ] Review general [code review guide](https://docs.gitlab.com/ee/development/code_review.html) +- [ ] Review [database review documentation](https://about.gitlab.com/handbook/engineering/workflow/code-review/database.html) +- [ ] Familiarize with [migration helpers](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/lib/gitlab/database/migration_helpers.rb) and review usage in existing migrations +- [ ] Read [database migration style guide](https://docs.gitlab.com/ee/development/migration_style_guide.html) +- [ ] Familiarize with best practices in [database guides](https://docs.gitlab.com/ee/development/#database-guides) +- [ ] Watch [Optimising Rails Database Queries: Episode 1](https://www.youtube.com/watch?v=79GurlaxhsI) +- [ ] Read [Understanding EXPLAIN plans](https://docs.gitlab.com/ee/development/understanding_explain_plans.html) +- [ ] Review [database best practices](https://docs.gitlab.com/ee/development/#best-practices) +- [ ] Review how we use [database instances restored from a backup](https://ops.gitlab.net/gitlab-com/gl-infra/gitlab-restore/postgres-gprd) for testing and make sure you're set up to execute pipelines (check [README.md](https://ops.gitlab.net/gitlab-com/gl-infra/gitlab-restore/postgres-gprd/blob/master/README.md) and reach out to @abrandl since this is currently subject to being changed) +- [ ] Get yourself added to [`@gl-database`](https://gitlab.com/groups/gl-database/-/group_members) group and respond to @-mentions to the group (reach out to any maintainer on the group to get added). You will get TODOs on gitlab.com for group mentions. +- [ ] Make sure you have proper access to at least a read-only replica in staging and production +- [ ] Indicate in `data/team.yml` your role as a database reviewer ([example MR](https://gitlab.com/gitlab-com/www-gitlab-com/merge_requests/19600/diffs)). Assign MR to your manager for merge. +- [ ] Send one MR to improve the [review documentation](https://about.gitlab.com/handbook/engineering/workflow/code-review/database.html) or the [issue template](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/.gitlab/issue_templates/Database%20Reviewer.md) + +Note that *approving and accepting* merge requests is *restricted* to +Database Maintainers only. As a reviewer, pass the MR to a maintainer +for approval. + +You're all set! Watch out for TODOs on GitLab.com. + +###### Where to go for questions? + +Reach out to `#database` on Slack and mention `@abrandl` for any questions. + +cc @abrandl + +/label ~meta ~database diff --git a/.gitlab/issue_templates/Documentation.md b/.gitlab/issue_templates/Documentation.md index c0919aeeda4..67602b7b2df 100644 --- a/.gitlab/issue_templates/Documentation.md +++ b/.gitlab/issue_templates/Documentation.md @@ -9,7 +9,7 @@ * For information about documentation content and process, see https://docs.gitlab.com/ee/development/documentation/ --> -### Type of issue +<!-- Type of issue --> <!-- Un-comment the line for the applicable doc issue type to add its label. Note that all text on that line is deleted upon issue creation. --> diff --git a/.gitlab/issue_templates/Feature proposal.md b/.gitlab/issue_templates/Feature proposal.md index eef1e877ff2..8a49715e0e8 100644 --- a/.gitlab/issue_templates/Feature proposal.md +++ b/.gitlab/issue_templates/Feature proposal.md @@ -2,32 +2,10 @@ <!-- What problem do we solve? --> -### Target audience +### Intended users -<!--- For whom are we doing this? Include a [persona](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/) -listed below, if applicable, along with its [label](https://gitlab.com/groups/gitlab-org/-/labels?utf8=%E2%9C%93&subscribed=&search=persona%3A), -or define a specific company role, e.g. "Release Manager". - -Existing personas are: (copy relevant personas out of this comment, and delete any persona that does not apply) - -- Parker, Product Manager, https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas#parker-product-manager -/label ~"Persona: Product Manager" - -- Delaney, Development Team Lead, https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas#delaney-development-team-lead -/label ~"Persona: Development Team Lead" - -- Sasha, Software Developer, https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas#sasha-software-developer -/label ~"Persona: Software developer" - -- Devon, DevOps Engineer, https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas#devon-devops-engineer -/label ~"Persona: DevOps Engineer" - -- Sidney, Systems Administrator, https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas#sidney-systems-administrator -/label ~"Persona: Systems Administrator" - -- Sam, Security Analyst, https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas#sam-security-analyst -/label ~"Persona: Security Analyst" ---> +<!-- Who will use this feature? If known, include any of the following: types of users (e.g. Developer), personas, or specific company roles (e.g. Release Manager). It's okay to write "Unknown" and fill this field in later. +Personas can be found at https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/ --> ### Further details @@ -46,6 +24,10 @@ Existing personas are: (copy relevant personas out of this comment, and delete a <!-- See the Feature Change Documentation Workflow https://docs.gitlab.com/ee/development/documentation/feature-change-workflow.html Add all known Documentation Requirements here, per https://docs.gitlab.com/ee/development/documentation/feature-change-workflow.html#documentation-requirements --> +### Testing + +<!-- What risks does this change pose? How might it affect the quality of the product? What additional test coverage or changes to tests will be needed? Will it require cross-browser testing? See the test engineering process for further guidelines: https://about.gitlab.com/handbook/engineering/quality/guidelines/test-engineering/ --> + ### What does success look like, and how can we measure that? <!-- Define both the success metrics and acceptance criteria. Note that success metrics indicate the desired business outcomes, while acceptance criteria indicate when the solution is working correctly. If there is no way to measure success, link to an issue that will implement a way to measure this. --> diff --git a/.gitlab/issue_templates/Refactoring.md b/.gitlab/issue_templates/Refactoring.md new file mode 100644 index 00000000000..cd0ce8486f0 --- /dev/null +++ b/.gitlab/issue_templates/Refactoring.md @@ -0,0 +1,41 @@ +## Summary + +<!-- +Please briefly describe what part of the code base needs to be refactored. +--> + +## Improvements + +<!-- +Explain the benefits of refactoring this code. +See also https://about.gitlab.com/handbook/values/index.html#say-why-not-just-what +--> + +## Risks + +<!-- +Please list features that can break because of this refactoring and how you intend to solve that. +--> + +## Involved components + +<!-- +List files or directories that will be changed by the refactoring. +--> + +## Optional: Intended side effects + +<!-- +If the refactoring involves changes apart from the main improvements (such as a better UI), list them here. +It may be a good idea to create separate issues and link them here. +--> + + +## Optional: Missing test coverage + +<!-- +If you are aware of tests that need to be written or adjusted apart from unit tests for the changed components, +please list them here. +--> + +/label ~backstage diff --git a/.gitlab/issue_templates/Test plan.md b/.gitlab/issue_templates/Test plan.md index a3c3f4a6509..3aedd5859d3 100644 --- a/.gitlab/issue_templates/Test plan.md +++ b/.gitlab/issue_templates/Test plan.md @@ -93,4 +93,4 @@ When adding new automated tests, please keep [testing levels](https://docs.gitla in mind. --> -/label ~Quality ~"test plan" +/label ~Quality ~"test\-plan" |