Skip to content
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

[config] [Sweep Rules] Add docstrings to sweep.yaml #165

Closed
wants to merge 1 commit into from
Closed

[config] [Sweep Rules] Add docstrings to sweep.yaml #165

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
3 changes: 2 additions & 1 deletion sweep.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# This setting contains a list of rules that Sweep will check for. If any of these rules are broken in a new commit, Sweep will create an pull request to fix the broken rule.
rules:
- "All new business logic should have corresponding unit tests."
- "Add jsdoc to all functions and file headers."
- "Add docstrings to all functions and file headers."

# This is the branch that Sweep will develop from and make pull requests to. Most people use 'main' or 'master' but some users also use 'dev' or 'staging'.
branch: 'main'
Expand Down Expand Up @@ -34,6 +34,7 @@ description: |
- **Axios**: Promise-based HTTP client for making API calls.
- **@mui/material**: Material-UI library for React components.
- **Docker**: Used for containerizing the frontend service for quick setup and testing.
- **JSDoc**: Documentation format for JavaScript code.

# This sets whether to create pull requests as drafts. If this is set to True, then all pull requests will be created as drafts and GitHub Actions will not be triggered.
draft: True
Expand Down
Loading