Repository navigation
docs: document CI gates and add a pull request skill - #5
Merged
Merged
Conversation
- Added a comprehensive section on CI processes, detailing the GitHub Actions workflow for linting, formatting, and testing. - Included instructions for running local checks and outlined the branch protection rules for the `main` branch. - Emphasized the importance of maintaining a minimum test coverage of 90% for the `todo_api`.
- Introduced a new markdown file for the pull request skill, detailing the process for drafting and publishing GitHub pull requests. - Included instructions for running local checks with Ruff, Mypy, and Pytest, along with guidelines for writing titles and descriptions. - Emphasized the importance of including CI results in the pull request description to maintain transparency and clarity.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
mainbranch protection rules in the README.CI results
Checked locally before this pull request was published.