Skip to content

Latest commit

 

History

History
107 lines (72 loc) · 3.84 KB

README_Template.md

File metadata and controls

107 lines (72 loc) · 3.84 KB
Raw

YaST <FOO> Module

Travis Build Jenkins Build Coverage Status Code Climate Inline docs

This file is a README.md template for YaST modules.

Keep the file reasonably short, if some section becomes too long put the details in a separate file and link the content from here. Remove the unneeded sections.

This file should describe the module for developers, like:

  • What is the project good for - what does it actually do (and how), what it cannot do (unsupported scenarios), limitations
  • Links to the documentation, high level and low level descriptions (e.g. RFC, wikipedia articles, man pages, project documentation, openSUSE wiki), terminology
  • How to fetch the source code (if something outside Git is needed it should be mentioned)
  • What prerequisites are needed to build the sources (external libraries, gems, scripts, …)
  • How to build the sources (make/rake commands…)
  • How to setup a testing environment (e.g. iSCSI target for iSCSI client)
  • How to run the code to test a change (esp. needed for non trivial projects like linuxrc)
  • How to run automated tests
  • How to build a package for submission
  • How to submit the package (if it needs some manual steps)
  • Troubleshooting (how to solve typical problems)

Description

This should be a short description for users of the module.

This YaST module configures ....

Features

  • ...
  • ...

Limitations

  • ...
  • ...

Development

This module is developed as part of YaST. See the development documentation.

Getting the Sources

To get the source code, clone the GitHub repository:

$ git clone https://github.com/yast/<repository>.git

If you want to contribute into the project you can fork the repository and clone your fork.

Development Environment

If the module needs specific development setup then describe it here, otherwise remove this section.

Testing Environment

Here describe (or link the docu, man pages,...) how to setup a specific environment needed for running and testing the module.

Example: for iSCSI client you might describe (or link) how to setup an iSCSI server so it could be used by the client module.

Troubleshooting

Here you can describe (or link) some usefull hints for common problems when developing the module. You should describe just tricky solutions which need some deep knowledge about the module or the system and it is difficult to figure it out.

Example: If the module crashes after compiling and installing a new version remove /var/cache/foo/ content and start it again.

Contact

If you have any question, feel free to ask at the development mailing list or at the #yast IRC channel on libera.chat.