Skip to content

Commit

Permalink
docs(contribution-guidelines): add sourcery-ai changes
Browse files Browse the repository at this point in the history
  • Loading branch information
JeremyFriesenGitHub committed Sep 4, 2024
1 parent 515bbb1 commit 22097c6
Showing 1 changed file with 5 additions and 40 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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(<scope of PR>): <description (similar to commits)>
```
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(<scope of PR>): <description (similar to commits)>
```

- **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(<scope of PR>): <description (similar to commits)>
```

- **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)
Expand All @@ -81,6 +46,6 @@ docs(<scope of PR>): <description (similar to commits)>

- [ ] 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

0 comments on commit 22097c6

Please sign in to comment.