Skip to content

Commit

Permalink
back: Update commit rules in sweep.yaml.
Browse files Browse the repository at this point in the history
The commit message rules in the sweep.yaml file have been updated. A new
rule about adding jsdoc to all functions and file headers has been added.

Signed-off-by: Nikolay Martyanov <[email protected]>
  • Loading branch information
OhmSpectator committed Dec 20, 2023
1 parent 7716f3f commit d9945bc
Showing 1 changed file with 1 addition and 23 deletions.
24 changes: 1 addition & 23 deletions sweep.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +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."
- "Refactor large functions to be more modular."
- "Add docstrings to all functions and file headers."
- "In the PR description, provide the Issue number that your PR fixes in a form `Fixes #<Issue Number>`"
- "Make changes only in the directory you are working on (frontend, backend, or deployment)."
- "For JavaScript (used in frontend and backend), follow the Airbnb JavaScript Style Guide"
- "For Python (used in deployment scripts), use Black"
- |
Follow this format for all commit messages:
```
<Type>: <Topic>.
<Description>
[Issue: #<GitHub Issue Number>]
```
Type can be one of the following:
- `front`: Frontend
- `back`: Backend
- `deploy`: Deployment
Or leave it blank if the commit is not specific to any of the above.
Ensure the commit message is concise yet descriptive.
If the commit fixes an issue, add the issue number in the commit message.
- "Add jsdoc 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

0 comments on commit d9945bc

Please sign in to comment.