From a835fa013283f3e3184664ed6a7f6d2a3ba533e6 Mon Sep 17 00:00:00 2001 From: Alec Reynolds Date: Mon, 8 Apr 2024 20:28:14 -0700 Subject: [PATCH] Improve contribution information. --- .github/PULL_REQUEST_TEMPLATE.md | 23 +++++++++++++++++++++++ README.md | 6 ++++++ docs/.vitepress/config.mjs | 4 ++-- 3 files changed, 31 insertions(+), 2 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md 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 4a4badd..e7d7dbe 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,12 @@ We try to log all changes big and small in both [THE CHANGELOG](https://github.c If you're interested in working on this plugin then we recommend you check out the [development guide](https://github.com/lando/acquia/blob/main/docs/development.md). + +## 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 303fa82..b398d4c 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -52,9 +52,9 @@ function sidebar() { {text: 'GitHub', link: 'https://github.com/lando/acquia/issues/new/choose'}, {text: 'Slack', link: 'https://www.launchpass.com/devwithlando'}, {text: 'Contact Us', link: '/support'}, + {text: 'Examples', link: 'https://github.com/lando/acquia/tree/main/examples'}, ], }, {text: 'Guides', link: '/guides', activeMatch: '/guides'}, - {text: 'Examples', link: 'https://github.com/lando/acquia/tree/main/examples'}, ]; -}; +}; \ No newline at end of file