Added generic README files #346
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,87 +1,4 @@ | ||
| YaST Contribution Guidelines | ||
| ============================ | ||
|
|
||
| See the [YaST contribution guidelines](http://yastgithubio.readthedocs.org/en/latest/contributing/) document. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
|
|
||
| YaST <FOO> Module | ||
|
There was a problem hiding this comment. Later, it would also make sense to link a good README file that shows how we expect the docs to look like. Example is IMO needed. There was a problem hiding this comment. We should adapt all READMEs to follow this template, later any repository could be used as an example. |
||
| ======================= | ||
|
|
||
| <!-- Adapt the used badges, keep the order unchanged so it is unified for all repositories. | ||
| To use the badges replace "foo" by the real repository name. --> | ||
| [](https://travis-ci.org/yast/yast-foobar) | ||
| [](https://ci.opensuse.org/view/Yast/job/yast-foo-master/) | ||
| [](https://coveralls.io/r/yast/yast-foobar?branch=master) | ||
|
There was a problem hiding this comment. Please add a comment how to put a new SVG image there |
||
| [](https://codeclimate.com/github/yast/yast-foobar) | ||
| [](http://inch-ci.org/github/yast/yast-foobar) | ||
|
|
||
| > *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](http://yastgithubio.readthedocs.org/en/latest/development/). | ||
|
|
||
|
|
||
| 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](https://help.github.com/articles/fork-a-repo/) 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 <b>developing</b> 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](http://lists.opensuse.org/yast-devel/) or at the | ||
| [#yast](https://webchat.freenode.net/?channels=%23yast) IRC channel on freenode. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is also generic, shouldn't we have it in a generic docu? In fact, we have it there... http://yast.github.io/contributing.html -- See "Meet others involved"