feat: add support for .opencommitignore file (#22)

* feat: add support for .opencommitignore
This commit is contained in:
Stuart van Beek
2023-03-19 09:01:57 +01:00
committed by GitHub
parent d793bf1340
commit 3f7025d50a
5 changed files with 40 additions and 8 deletions
+12
View File
@@ -98,6 +98,18 @@ is translated to :
git commit -m "${generatedMessage}" --no-verify
```
### Ignore files
You can ignore files from submission to OpenAI by creating a `.opencommitignore` file. For example:
```ignorelang
path/to/large-asset.zip
**/*.jpg
```
This is useful for preventing opencommit from uploading artifacts and large files.
By default, opencommit ignores files matching: `*-lock.*` and `*.lock`
## Git hook
You can set OpenCommit as Git [`prepare-commit-msg`](https://git-scm.com/docs/githooks#_prepare_commit_msg) hook. Hook integrates with you IDE Source Control and allows you edit the message before commit.