openSUSE / openSUSE/supportutils

documentation for plugin writers?

Open
#212 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Shell
Stars
35
Forks
70
Avg merge
5d 16h
Merged PRs (30d)
1

Description

Is there any documentation for plugin writers, could you point me to it?

What is the context in which a plugin script runs?

Which resources can a script rely on? Can it access anywhere in the file system? write a temporary file? Where?
Can it use networking resources?

Is everything that a plugin writes collected? Maybe if it is in the "current" directory? Can a plugin script change the current working directory?

Thanks for any help,

C

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files or tests. Start by locating the plugin execution entry point and any existing plugin documentation, then document the runtime context, available resources, filesystem and networking access, working-directory behavior, and how plugin output is collected.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.