From 22097c6240ca3427815f0124c6064495d6f03608 Mon Sep 17 00:00:00 2001 From: JeremyFriesenGitHub Date: Wed, 4 Sep 2024 11:22:39 -0400 Subject: [PATCH] docs(contribution-guidelines): add sourcery-ai changes --- .../contribution-guidelines/pull-requests.mdx | 45 +++---------------- 1 file changed, 5 insertions(+), 40 deletions(-) diff --git a/apps/docs/src/content/docs/contribution-guidelines/pull-requests.mdx b/apps/docs/src/content/docs/contribution-guidelines/pull-requests.mdx index 53f2de79..7556c863 100644 --- a/apps/docs/src/content/docs/contribution-guidelines/pull-requests.mdx +++ b/apps/docs/src/content/docs/contribution-guidelines/pull-requests.mdx @@ -20,52 +20,17 @@ When creating a Pull Request (PR), be mindful about what you're trying to contri - Be sure to checkout [Branching Guidelines](/docs/contribution-guidelines/branching-guidelines), [Coding Guidelines](/docs/contribution-guidelines/coding-guidelines) and [Commit Conventions](/docs/contribution-guidelines/conventional-commits) before making a PR. - Use the appropriate template that matches with your branch type. - Ensure your PR scope and subject align with your main commit(s). -- If your code isn’t fully ready to be merged, consider creating a draft PR instead. +- If your code isn’t fully ready to be merged, you can use sourcery-ai to help fix any discrepancies. - Be sure to link your PR branches with the according issue (if applicable). If you're getting tired of storing work in progress by stashing changes or amending commits and then switching branches, it's a great sign to look into using [Git Worktrees](https://www.theserverside.com/blog/Coffee-Talk-Java-News-Stories-and-Opinions/Use-this-git-worktree-add-example-and-never-switch-branches-again). -Here are a few PR templates to get you started: - -### Features -Title your PR with the following format: -```bash -feat(): -``` -Describe your PR with the following sections and questions: - -- **What feature(s) does this PR add?** -- **Why do we need this feature? How does this PR address the issue?** -- **Before and After Screenshots (if applicable)** -- **Additional comments (if applicable)** - - -### Tests -Title your PR with the following format: -```bash -test(): -``` - -- **What tests does this PR add?** -- **Why do we need this? How does this PR address the issue?** -- **Screenshots (if applicable)** -- **Additional comments (if applicable)** - - -### Docs -Title your PR with the following format: -```bash -docs(): -``` - -- **What does this PR add to the docs?** -- **Why do we need this? How does this PR address the issue?** -- **Screenshots (if applicable)** -- **Additional comments (if applicable)** - +For detailed PR templates, please refer to our [PR Templates](https://github.com/cuhacking/2025/tree/main/.github/PULL_REQUEST_TEMPLATE) directory. These templates should automatically show up whenever you create a new PR (similar to GitHub issues). {/*TODO: Create frontend interactive-checklist*/} ## Pull Request Checklist +Before makign a PR, be sure to check off the following items: + ### **Code Quality** - [ ] Code is clean and readable (functions used appropriately) @@ -81,6 +46,6 @@ docs(): - [ ] PR is linked to an issue (if applicable) - [ ] PR is clear and comprehensible -- [ ] PR is ready for review (if not, consider using a draft PR) +- [ ] PR is ready for review (no draft PRs, this way sourcery-ai can do its magic) - [ ] PR title follows template guidelines - [ ] PR description follows template guidelines \ No newline at end of file