diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..01a3240 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,23 @@ +### Bare minimum self-checks + +> [What do you think of a person who only does the bare minimum?](https://getyarn.io/yarn-clip/dcf80710-425e-478b-bde1-c107bd11e849) + +- [ ] I've updated this PR with the latest code from `main` +- [ ] I've done a cursory QA pass of my code locally +- [ ] I've ensured all automated status check and tests pass +- [ ] I've [connected this PR to an issue](https://help.zenhub.com/support/solutions/articles/43000010350-connecting-pull-requests-to-github-issues) + +### Pieces of flare + +- [ ] I've written a unit or functional test for my code +- [ ] I've updated relevant documentation it my code changes it +- [ ] I've updated this repo's README if my code changes it +- [ ] I've updated this repo's CHANGELOG with my change unless its a trivial change (like updating a typo in the docs) + +### Finally + +- [ ] I've [requested a review](https://help.github.com/en/articles/requesting-a-pull-request-review) with relevant people + +If you have any issues or need help please join the `#contributors` channel in the [Lando slack](https://www.launchpass.com/devwithlando) and someone will gladly help you out! + +You can also check out the [coder guide](https://docs.lando.dev/contrib/coder.html). diff --git a/README.md b/README.md index 595187e..5d21488 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,12 @@ If you'd like to report a bug or submit a feature request then please [use the i We try to log all changes big and small in both [THE CHANGELOG](https://github.com/lando/mariadb/blob/main/CHANGELOG.md) and the [release notes](https://github.com/lando/mariadb/releases). + +## Maintainers + +* [@pirog](https://github.com/pirog) +* [@reynoldsalec](https://github.com/reynoldsalec) + ## Contributors diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index 3ea96d4..5f5b1a8 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -49,8 +49,8 @@ function sidebar() { {text: 'GitHub', link: 'https://github.com/lando/mariadb/issues/new/choose'}, {text: 'Slack', link: 'https://www.launchpass.com/devwithlando'}, {text: 'Contact Us', link: '/support'}, + {text: 'Examples', link: 'https://github.com/lando/mariadb/tree/main/examples'}, ], }, - {text: 'Examples', link: 'https://github.com/lando/mariadb/tree/main/examples'}, ]; -}; +}; \ No newline at end of file