Skip to content

Commit 4d4a7c9

Browse files
committed
Add some support files
1 parent 8948752 commit 4d4a7c9

File tree

2 files changed

+92
-0
lines changed

2 files changed

+92
-0
lines changed

.sourcery.yaml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
# 🪄 This is your project's Sourcery configuration file.
3+
4+
# You can use it to get Sourcery working in the way you want, such as
5+
# ignoring specific refactorings, skipping directories in your project,
6+
# or writing custom rules.
7+
8+
# 📚 For a complete reference to this file, see the documentation at
9+
# https://docs.sourcery.ai/Configuration/Project-Settings/
10+
11+
# This file was auto-generated by Sourcery on 2023-06-03 at 01:10.
12+
13+
version: '1' # The schema version of this config file
14+
15+
ignore: # A list of paths or files which Sourcery will ignore.
16+
- .git
17+
- venv
18+
- .venv
19+
- env
20+
- .env
21+
- .tox
22+
- node_modules
23+
- vendor
24+
25+
rule_settings:
26+
enable:
27+
- default
28+
disable: [] # A list of rule IDs Sourcery will never suggest.
29+
rule_types:
30+
- refactoring
31+
- suggestion
32+
- comment
33+
python_version: '2.7' # A string specifying the lowest Python version your project supports. Sourcery will not suggest refactorings requiring a higher Python version.
34+
35+
# rules: # A list of custom rules Sourcery will include in its analysis.
36+
# - id: no-print-statements
37+
# description: Do not use print statements in the test directory.
38+
# pattern: print(...)
39+
# language: python
40+
# replacement:
41+
# condition:
42+
# explanation:
43+
# paths:
44+
# include:
45+
# - test
46+
# exclude:
47+
# - conftest.py
48+
# tests: []
49+
# tags: []
50+
51+
# rule_tags: {} # Additional rule tags.
52+
53+
# metrics:
54+
# quality_threshold: 25.0
55+
56+
# github:
57+
# labels: []
58+
# ignore_labels:
59+
# - sourcery-ignore
60+
# request_review: author
61+
# sourcery_branch: sourcery/{base_branch}
62+
63+
# clone_detection:
64+
# min_lines: 3
65+
# min_duplicates: 2
66+
# identical_clones_only: false
67+
68+
# proxy:
69+
# url:
70+
# ssl_certs_file:
71+
# no_ssl_verify: false

doc/development/chatgpt.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
## Use of generative AI for plugin creation
2+
3+
You can use a sample text to get a plugin draft created for later review, for example:
4+
5+
```console
6+
7+
8+
I want to create a bash script for checking system status.
9+
10+
The script should use return codes to indicate success, failure, information, error or skipped via the values stored in the variables $RC_OKAY, $RC_SKIPPED, $RC_ERROR, $RC_FAILED and $RC_INFO.
11+
12+
The Path to check for the files in the sosreport are specified in the var $RISU_ROOT when we're running against a sosreport or in the regular system locations when we're running against a live system.
13+
14+
We can know if we're running against a live system by checking the value of the variable RISU_LIVE which is 0 when we're running against a sosreport or 1 when we're running on a live system.
15+
16+
If the script needs to output any relevant information in case of Error, being skipped, etc, it should always write to the standard error instead of the standard output.
17+
18+
The script should check how full is the etcd database in kubernetes
19+
```
20+
21+
Just replace the text for the intended check to perform and review that everything makes sense at the end.

0 commit comments

Comments
 (0)