diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2021-12-04 03:31:49 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2021-12-04 03:31:49 +0000 |
| commit | 23d0ac82f3d68663ddc74a0e1f9b963beb8d62b9 (patch) | |
| tree | fc37aa2c97a3d28b3dee7f3892041158981ed335 /docs/user_defined_rules.md | |
| parent | Releasing progress-linux version 0.16.0-1. (diff) | |
| download | gitlint-23d0ac82f3d68663ddc74a0e1f9b963beb8d62b9.tar.xz gitlint-23d0ac82f3d68663ddc74a0e1f9b963beb8d62b9.zip | |
Merging upstream version 0.17.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/user_defined_rules.md')
| -rw-r--r-- | docs/user_defined_rules.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/user_defined_rules.md b/docs/user_defined_rules.md index 3b9f5e7..f58dcc7 100644 --- a/docs/user_defined_rules.md +++ b/docs/user_defined_rules.md @@ -374,7 +374,7 @@ class ReleaseConfigurationRule(ConfigurationRule): ``` For all available properties and methods on the `config` object, have a look at the -[LintConfig class](https://github.com/jorisroovers/gitlint/blob/main/gitlint/config.py). Please do not use any +[LintConfig class](https://github.com/jorisroovers/gitlint/blob/main/gitlint-core/gitlint/config.py). Please do not use any properties or methods starting with an underscore, as those are subject to change. @@ -385,7 +385,7 @@ As long as you stick with simple rules that are similar to the sample user-defin should be able to discover and execute them. While clearly you can run any python code you want in your rules, you might run into some issues if you don't follow the conventions that gitlint requires. -While the [rule finding source-code](https://github.com/jorisroovers/gitlint/blob/main/gitlint/rule_finder.py) is the +While the [rule finding source-code](https://github.com/jorisroovers/gitlint/blob/main/gitlint-core/gitlint/rule_finder.py) is the ultimate source of truth, here are some of the requirements that gitlint enforces. ### Rule class requirements |