Skip to content

Commit

Permalink
Add some support files
Browse files Browse the repository at this point in the history
  • Loading branch information
iranzo committed Aug 22, 2024
1 parent 8948752 commit 4d4a7c9
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 0 deletions.
71 changes: 71 additions & 0 deletions .sourcery.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
# 🪄 This is your project's Sourcery configuration file.

# You can use it to get Sourcery working in the way you want, such as
# ignoring specific refactorings, skipping directories in your project,
# or writing custom rules.

# 📚 For a complete reference to this file, see the documentation at
# https://docs.sourcery.ai/Configuration/Project-Settings/

# This file was auto-generated by Sourcery on 2023-06-03 at 01:10.

version: '1' # The schema version of this config file

ignore: # A list of paths or files which Sourcery will ignore.
- .git
- venv
- .venv
- env
- .env
- .tox
- node_modules
- vendor

rule_settings:
enable:
- default
disable: [] # A list of rule IDs Sourcery will never suggest.
rule_types:
- refactoring
- suggestion
- comment
python_version: '2.7' # A string specifying the lowest Python version your project supports. Sourcery will not suggest refactorings requiring a higher Python version.

# rules: # A list of custom rules Sourcery will include in its analysis.
# - id: no-print-statements
# description: Do not use print statements in the test directory.
# pattern: print(...)
# language: python
# replacement:
# condition:
# explanation:
# paths:
# include:
# - test
# exclude:
# - conftest.py
# tests: []
# tags: []

# rule_tags: {} # Additional rule tags.

# metrics:
# quality_threshold: 25.0

# github:
# labels: []
# ignore_labels:
# - sourcery-ignore
# request_review: author
# sourcery_branch: sourcery/{base_branch}

# clone_detection:
# min_lines: 3
# min_duplicates: 2
# identical_clones_only: false

# proxy:
# url:
# ssl_certs_file:
# no_ssl_verify: false
21 changes: 21 additions & 0 deletions doc/development/chatgpt.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Use of generative AI for plugin creation

You can use a sample text to get a plugin draft created for later review, for example:

```console


I want to create a bash script for checking system status.

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.

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.

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.

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.

The script should check how full is the etcd database in kubernetes
```

Just replace the text for the intended check to perform and review that everything makes sense at the end.

0 comments on commit 4d4a7c9

Please sign in to comment.