Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Update Contributing.md to reflect the current development flow.
  • Loading branch information
takumiohym authored Nov 20, 2024
1 parent 9c4854f commit a78d8f2
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,14 @@ _For maintainers:_
## `pre-commit`

### TLDR
`pre-commit` is installed in the setup process defined in the [README.md](https://github.com/GoogleCloudPlatform/asl-ml-immersion/blob/master/README.md). When you commit, pre-commit checks the syntax and suggest auto-fixes if necessary. Accept auto-fixes, and resolve any issues, and re-commit.

If the `pre-commit.ci` check fails, please install and run `pre-commit` in your development environment as follows, accept auto-fixes and resolve any issues, and re-commit.

Normal development flow:
```bash
python3 -m pip install pre-commit
cd ~/asl-ml-immersion # or wherever your repo is
pre-commit install
pre-commit run --all-files
# fix any issues that weren't auto-fixed, such as `pylint` issues
git commit -a -m "pre-commit"
git add <MODIFIED FILES>
git commit -m "YOUR COMMIT MESSAGE" # pre-commit checks the syntax and suggest auto-fixes if necessary.
# Check the auto-fixes and resolve any issues.
git commit -m "YOUR COMMIT MESSAGE" # re-commit.
```

### Intro: Linters
Expand Down Expand Up @@ -108,7 +106,7 @@ Syntax errors understandably trip multiple checks. The best way is to try to rew
variable = # TODO

# use this:
variable = None # TODO
variable = ... # TODO
```

```python
Expand Down

0 comments on commit a78d8f2

Please sign in to comment.