Skip to content

Optimize Code Quality Docs #294

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tembo wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Optimize Code Quality Docs #294

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 5 additions & 19 deletions automations-library/code-quality-cicd.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,22 +59,8 @@ A CI check has failed on PR #{pr_number}.

## Tips for Code Quality & CI/CD Automations

### Start with Low-Risk Fixes

Begin with automations that only fix formatting and linting issues. These are safe to auto-fix and won't break functionality.

### Always Notify the Team

When an automation makes changes to code, always leave a comment explaining what was fixed and why. This maintains transparency.

### Set Clear Boundaries

Define explicitly what the automation can and cannot fix. For example, never auto-fix failing tests without human review.

### Track Success Rates

Monitor how often your automation successfully fixes issues versus how often manual intervention is needed. Use this data to improve your prompts.

### Integrate with Issue Tracking

For issues that can't be auto-fixed, automatically create tickets in Linear or Jira with details about the failure.
- **Start with low-risk fixes**: Only auto-fix formatting and linting issues initially—these won't break functionality.
- **Always notify the team**: Leave clear comments explaining what was fixed and why.
- **Set clear boundaries**: Define explicitly what can and cannot be auto-fixed (never auto-fix failing tests without human review).
- **Track success rates**: Monitor auto-fix success vs manual intervention to improve prompts over time.
- **Integrate with issue tracking**: Auto-create tickets in Linear or Jira for issues that can't be auto-fixed.