From b08c63f3dd749a3108734330460648294a762c34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ladislav=20Slez=C3=A1k?= Date: Tue, 17 Feb 2015 09:30:43 +0100 Subject: [PATCH 1/6] Added generic README files - `README_Template.md` - template for `README.md` files - `README_Generic.md` - shared generic documentation for all modules - `README_Generic_Rake.md` - shared generic documentation for modules using `rake` - `README_Generic_Autotools.md` - shared generic documentation for modules using sutotools - adapted `README.md` to follow the template and linking to the shared generic documentation above --- README.md | 63 ++++++++++++++--- doc/README_Generic.md | 61 ++++++++++++++++ doc/README_Generic_Autotools.md | 50 ++++++++++++++ doc/README_Generic_Rake.md | 51 ++++++++++++++ doc/README_Template.md | 119 ++++++++++++++++++++++++++++++++ 5 files changed, 335 insertions(+), 9 deletions(-) create mode 100644 doc/README_Generic.md create mode 100644 doc/README_Generic_Autotools.md create mode 100644 doc/README_Generic_Rake.md create mode 100644 doc/README_Template.md diff --git a/README.md b/README.md index f783689fd..7cc72e8ec 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# YaST - The Basic Libraries # +YaST - The Basic Libraries +========================== [![Travis Build](https://travis-ci.org/yast/yast-yast2.svg?branch=master)](https://travis-ci.org/yast/yast-yast2) [![Coverage Status](https://img.shields.io/coveralls/yast/yast-yast2.svg)](https://coveralls.io/r/yast/yast-yast2?branch=master) @@ -9,16 +10,60 @@ This repository contains basic set of shared libraries and so-called SCR agents used for reading and writing configuration files and some even for executing commands on the system. -## Installation ## - make -f Makefile.cvs - make - sudo make install +Provided Functionality +====================== -## Running Testsuites ## +See [the generated yardoc documentation](http://www.rubydoc.info/github/yast/yast-yast2) at rubydoc.info. - make check +Development +=========== -## Links ## +This module is developed as part of YaST. See the generic +[development documentation](doc/README_Generic.md#yast-development-documentation) and +[development environment](doc/README_Generic.md#development-environment) description. - * See more at http://en.opensuse.org/openSUSE:YaST_development + +Getting the Sources +=================== + +To get the source code, clone the GitHub repository: + + $ git clone https://github.com/yast/yast-yast2.git + +Alternatively, you can fork the repository and clone your fork. This is most +useful if you plan to contribute into the project and you do not have push +permission to the repository. + + +Installing the Library +====================== + +See [the generic building and installing](doc/README_Generic_Autotools.md#building-and-installaing) +documentation. + + +Tests and Continuous Integration +================================ + +The tests are also run at a CI server, see +the [generic CI documentation](doc/README_Generic.md#continuous-integration) + + +Building and Submitting the Package +=================================== + +Before submitting any change please read our [contribution +guidelines](CONTRIBUTING.md). + +See the generic YaST documentation how to +[build](doc/README_Generic_Autotools.md#building-the-package) + a package and [submit](doc/README_Generic.md#submitting-the-package) it to the Open Build Service (OBS). + + +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. diff --git a/doc/README_Generic.md b/doc/README_Generic.md new file mode 100644 index 000000000..e6c3ad774 --- /dev/null +++ b/doc/README_Generic.md @@ -0,0 +1,61 @@ +Generic YaST README File +======================== + +YaST Development Documentation +------------------------------ + +- [YaST development documentation](http://yast.github.io/documentation.html) +- [Contribution Guidelines](http://yast.github.io/guidelines.html) +- [YaST architecture](http://yastgithubio.readthedocs.org/en/latest/architecture) +- [Development environment](https://en.opensuse.org/openSUSE:YaST:_Preparing_the_Development_Environment) + + +Development Environment +----------------------- +Before doing anything useful with the code, you need to setup a development +environment. Fortunately, this is quite simple, see the [preparing development +environment](https://en.opensuse.org/openSUSE:YaST:_Preparing_the_Development_Environment) +documentation. + + +### Extra Development Tools ### + +For running the automated tests you might need to install some more packages: + + $ sudo zypper install yast2-testsuite rubygem-rspec rubygem-simplecov + + +Continuous Integration +====================== + +Travis CI +--------- + +YaST uses [Travis CI](https://travis-ci.org) for building and running tests for commits and pull requests. +You can find more details in the [Travis CI Integration] +(http://yastgithubio.readthedocs.org/en/latest/travis-integration/) documentation. + +Jenkins CI +---------- + +For builing on native (open)SUSE distibution we use +[Jenkins CI openSUSE server](https://ci.opensuse.org/view/Yast/). It also [submits](#automatic-submission) the +built package to OBS. + + +Submitting the Package +====================== + +Automatic Submission +-------------------- + +The changes in `master` branch are automatically built and submitted to +[YaST:HEAD](https://build.opensuse.org/project/show/YaST:Head) OBS project +by [Jenkins CI](https://ci.opensuse.org/view/Yast/) after successful build. If the package version is changed then +a submit request to [openSUSE:Factory](https://build.opensuse.org/project/show/openSUSE:Factory) +is created automatically. + +Manual Submission +----------------- + +First build the package as described above. Then copy the content of `package/` directory to OBS project. diff --git a/doc/README_Generic_Autotools.md b/doc/README_Generic_Autotools.md new file mode 100644 index 000000000..804d60d03 --- /dev/null +++ b/doc/README_Generic_Autotools.md @@ -0,0 +1,50 @@ +Autotools Based YaST Packages +============================= + +This is a generic documenation for YaST packages which use autotools (autoconf/automake) +for building the package. + +Building and Installaing +-------------------------- + +To build the module run these commands: + + $ make -f Makefile.cvs + $ make + +If you want to rebuild the module later simply run `make` again. + +To install it run: + + $ sudo make install + +Note: This will overwrite the existing module in the system, be carefull when installing +a shared component (library) as it migth break some other modules. + + +Starting the Module +------------------- + +Run the module as root + + # yast2 + +or start the YaST control panel from the desktop menu and then run the appropriate module. + + +Running the Automated Tests +--------------------------- + +To run the testsuite, use the `check` target: + + $ make check + + +Building the Package +-------------------- + +To build a package for submitting into [Open Build Service](https://build.opensuse.org/) (OBS) you need to run + + $ make package-local + +in the top level directory. diff --git a/doc/README_Generic_Rake.md b/doc/README_Generic_Rake.md new file mode 100644 index 000000000..7ce3b4e02 --- /dev/null +++ b/doc/README_Generic_Rake.md @@ -0,0 +1,51 @@ +Rake Based YaST Packages +======================== + +This is a generic documenation for YaST packages which use `rake` for building the package. + +Building and Installaing +------------------------ + +So far the rake based modules do not need to be built, they are ready to be used just +after the Git clone. + +To install module run: + + $ sudo rake install + +Note: This will overwrite the existing module in the system, be carefull when installing +a shared component (library) as it migth break some other modules. + +Starting the Module +------------------- + +You can [start the installed module](README_Generic_Autotools.md#starting-the-module) +or you can run it directly from the Git checkout without need to install it first + +To run the module directly from the source code, use the `run` Rake task: + + $ rake run + + +Running the Automated Tests +--------------------------- + +To run the testsuite, use the `test:unit` Rake task: + + $ rake test:unit + +To run the tests with code coverage reporting run + + $ COVERAGE=1 rake test:unit + + +For a complete list of tasks, run `rake -T`. + + +Building the Package +-------------------- + +To build a package for submitting into [Open Build Service](https://build.opensuse.org/) (OBS) you need to run + + $ rake tarball + diff --git a/doc/README_Template.md b/doc/README_Template.md new file mode 100644 index 000000000..ab0486725 --- /dev/null +++ b/doc/README_Template.md @@ -0,0 +1,119 @@ + +YaST <FOO> Module +======================= + + +[![Travis Build](https://travis-ci.org/yast/yast-foo.svg?branch=master)](https://travis-ci.org/yast/yast-foobar) +[![Jenkins Build](http://img.shields.io/jenkins/s/https/ci.opensuse.org/yast-foo-master.svg)](https://ci.opensuse.org/view/Yast/job/yast-foo-master/) +[![Coverage Status](https://img.shields.io/coveralls/yast/yast-foobar.svg)](https://coveralls.io/r/yast/yast-foobar?branch=master) +[![Code Climate](https://codeclimate.com/github/yast/yast-foobar/badges/gpa.svg)](https://codeclimate.com/github/yast/yast-foobar) +[![Inline docs](http://inch-ci.org/github/yast/yast-foobar.svg?branch=master)](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.* + + +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 generic +[development documentation](README_Generic.md#yast-development-documentation) and +[development environment](README_Generic.md#development-environment) description. + + +Getting the Sources +=================== + +To get the source code, clone the GitHub repository: + + $ git clone https://github.com/yast/.git + +Alternatively, you can fork the repository and clone your fork. This is most +useful if you plan to contribute into the project and you do not have push +permission to the repository. + +Development Environment +======================= + +> *If the module needs specific development setup then describe it here, +> otherwise remove this section.* + + +Installing and Starting the Module +=================================== + + +See [the generic building, installing](README_Generic_Rake.md#building-and-installaing) +and [running](README_Generic_Rake.md#starting-the-module) documentation. + +See [the generic building, installing](README_Generic_Autotools.md#building-and-installaing) +and [running](README_Generic_Autotools.md#starting-the-module) documentation. + + +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.* + + +Tests and Continuous Integration +================================ + +The tests are also run at a CI server, see +the [generic CI documentation](README_Generic.md#continuous-integration) + + +Building and Submitting the Package +=================================== + +Before submitting any change please read our [contribution +guidelines](CONTRIBUTING.md). + + +See the generic YaST documentation how to +[build](README_Generic_Autotools.md#building-the-package) +[build](README_Generic_Rake.md#building-the-package) +a package and [submit](README_Generic.md#submitting-the-package) it to the Open Build Service (OBS). + + +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](http://lists.opensuse.org/yast-devel/) or at the +[#yast](https://webchat.freenode.net/?channels=%23yast) IRC channel on freenode. From 82434adb15af176306fe07520873bcc286b4d22b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ladislav=20Slez=C3=A1k?= Date: Fri, 20 Feb 2015 12:08:10 +0100 Subject: [PATCH 2/6] Update CONTRIBUTING.md Do not duplicate the content from http://yastgithubio.readthedocs.org, just link it. --- CONTRIBUTING.md | 85 +------------------------------------------------ 1 file changed, 1 insertion(+), 84 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5eadd699d..5bf83de28 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,87 +1,4 @@ YaST Contribution Guidelines ============================ -YaST is an open source project and as such it welcomes all kinds of -contributions. If you decide to contribute, please follow these guidelines to -ensure the process is effective and pleasant both for you and YaST maintainers. - -There are two main forms of contribution: reporting bugs and performing code -changes. - -Bug Reports ------------ - -If you find a problem, please report it either using -[Bugzilla](https://bugzilla.novell.com/enter_bug.cgi?format=guided&product=openSUSE+Factory&component=YaST2) -or [GitHub issues](../../issues). (For Bugzilla, use the [simplified -registration](https://secure-www.novell.com/selfreg/jsp/createSimpleAccount.jsp) -if you don't have an account yet.) - -If you find a problem, please report it either using -[Bugzilla](https://bugzilla.novell.com/) or GitHub issues. We can't guarantee -that every bug will be fixed, but we'll try. - -When creating a bug report, please follow our [bug reporting -guidelines](http://en.opensuse.org/openSUSE:Report_a_YaST_bug). - -Code Changes ------------- - -We welcome all kinds of code contributions, from simple bug fixes to significant -refactorings and implementation of new features. However, before making any -non-trivial contribution, get in touch with us first — this can prevent wasted -effort on both sides. Also, have a look at our [development -documentation](http://en.opensuse.org/openSUSE:YaST_development). - -To send us your code change, use GitHub pull requests. The workflow is as -follows: - - 1. Fork the project. - - 2. Create a topic branch based on `master`. - - 3. Implement your change, including tests (if possible). Make sure you adhere - to the [Ruby style - guide](https://github.com/SUSE/style-guides/blob/master/Ruby.md). - - 4. Make sure your change didn't break anything by building the RPM package - (`rake osc:build`). The build process includes running the full testsuite. - - 5. Publish the branch and create a pull request. - - 6. YaST developers will review your change and possibly point out issues. - Adapt the code under their guidance until they are all resolved. - - 7. Finally, the pull request will get merged or rejected. - -See also [GitHub's guide on -contributing](https://help.github.com/articles/fork-a-repo). - -If you want to do multiple unrelated changes, use separate branches and pull -requests. - -Do not change the `VERSION` and `*.changes` files as this could lead to -conflicts. - -### Commits - -Each commit in the pull request should do only one thing, which is clearly -described by its commit message. Especially avoid mixing formatting changes and -functional changes into one commit. When writing commit messages, adhere to -[widely used -conventions](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). - -If your commit is related to a bug in Buzgilla or an issue on GitHub, make sure -you mention it in the commit message for cross-reference. Use format like -bnc#775814 or gh#yast/yast-foo#42. See also [GitHub -autolinking](https://help.github.com/articles/github-flavored-markdown#references) -and [openSUSE abbreviation -reference](http://en.opensuse.org/openSUSE:Packaging_Patches_guidelines#Current_set_of_abbreviations). - -Additional Information ----------------------- - -If you have any question, feel free to ask at the [development mailing -list](http://lists.opensuse.org/yast-devel/) or at the -[#yast](http://webchat.freenode.net/?channels=%23yast) IRC channel on freenode. -We'll do our best to provide a timely and accurate answer. +See the [YaST contribution guidelines](http://yastgithubio.readthedocs.org/en/latest/contributing/) document. From 81af8ead62e85b0c107bea68bef1af89e85fad84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ladislav=20Slez=C3=A1k?= Date: Fri, 20 Feb 2015 12:09:41 +0100 Subject: [PATCH 3/6] Update README.md Updated contribution link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7cc72e8ec..a1bd5d6bb 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ Building and Submitting the Package =================================== Before submitting any change please read our [contribution -guidelines](CONTRIBUTING.md). +guidelines](http://yastgithubio.readthedocs.org/en/latest/contributing/). See the generic YaST documentation how to [build](doc/README_Generic_Autotools.md#building-the-package) From c0d676e055b605a9cf13ce295ae5e37b35fbfb12 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ladislav=20Slez=C3=A1k?= Date: Fri, 20 Feb 2015 19:13:33 +0100 Subject: [PATCH 4/6] the doc has been moved to yast.github.io --- README.md | 33 +++--------------- doc/README_Generic.md | 61 --------------------------------- doc/README_Generic_Autotools.md | 50 --------------------------- doc/README_Generic_Rake.md | 51 --------------------------- doc/README_Template.md | 36 ++----------------- 5 files changed, 6 insertions(+), 225 deletions(-) delete mode 100644 doc/README_Generic.md delete mode 100644 doc/README_Generic_Autotools.md delete mode 100644 doc/README_Generic_Rake.md diff --git a/README.md b/README.md index a1bd5d6bb..b79779322 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,6 @@ Provided Functionality See [the generated yardoc documentation](http://www.rubydoc.info/github/yast/yast-yast2) at rubydoc.info. -Development -=========== - -This module is developed as part of YaST. See the generic -[development documentation](doc/README_Generic.md#yast-development-documentation) and -[development environment](doc/README_Generic.md#development-environment) description. - Getting the Sources =================== @@ -36,29 +29,11 @@ useful if you plan to contribute into the project and you do not have push permission to the repository. -Installing the Library -====================== - -See [the generic building and installing](doc/README_Generic_Autotools.md#building-and-installaing) -documentation. - - -Tests and Continuous Integration -================================ - -The tests are also run at a CI server, see -the [generic CI documentation](doc/README_Generic.md#continuous-integration) - - -Building and Submitting the Package -=================================== - -Before submitting any change please read our [contribution -guidelines](http://yastgithubio.readthedocs.org/en/latest/contributing/). +Development +=========== -See the generic YaST documentation how to -[build](doc/README_Generic_Autotools.md#building-the-package) - a package and [submit](doc/README_Generic.md#submitting-the-package) it to the Open Build Service (OBS). +This module is developed as part of YaST. See the +[development documentation](http://yastgithubio.readthedocs.org/en/latest/development/). Contact diff --git a/doc/README_Generic.md b/doc/README_Generic.md deleted file mode 100644 index e6c3ad774..000000000 --- a/doc/README_Generic.md +++ /dev/null @@ -1,61 +0,0 @@ -Generic YaST README File -======================== - -YaST Development Documentation ------------------------------- - -- [YaST development documentation](http://yast.github.io/documentation.html) -- [Contribution Guidelines](http://yast.github.io/guidelines.html) -- [YaST architecture](http://yastgithubio.readthedocs.org/en/latest/architecture) -- [Development environment](https://en.opensuse.org/openSUSE:YaST:_Preparing_the_Development_Environment) - - -Development Environment ------------------------ -Before doing anything useful with the code, you need to setup a development -environment. Fortunately, this is quite simple, see the [preparing development -environment](https://en.opensuse.org/openSUSE:YaST:_Preparing_the_Development_Environment) -documentation. - - -### Extra Development Tools ### - -For running the automated tests you might need to install some more packages: - - $ sudo zypper install yast2-testsuite rubygem-rspec rubygem-simplecov - - -Continuous Integration -====================== - -Travis CI ---------- - -YaST uses [Travis CI](https://travis-ci.org) for building and running tests for commits and pull requests. -You can find more details in the [Travis CI Integration] -(http://yastgithubio.readthedocs.org/en/latest/travis-integration/) documentation. - -Jenkins CI ----------- - -For builing on native (open)SUSE distibution we use -[Jenkins CI openSUSE server](https://ci.opensuse.org/view/Yast/). It also [submits](#automatic-submission) the -built package to OBS. - - -Submitting the Package -====================== - -Automatic Submission --------------------- - -The changes in `master` branch are automatically built and submitted to -[YaST:HEAD](https://build.opensuse.org/project/show/YaST:Head) OBS project -by [Jenkins CI](https://ci.opensuse.org/view/Yast/) after successful build. If the package version is changed then -a submit request to [openSUSE:Factory](https://build.opensuse.org/project/show/openSUSE:Factory) -is created automatically. - -Manual Submission ------------------ - -First build the package as described above. Then copy the content of `package/` directory to OBS project. diff --git a/doc/README_Generic_Autotools.md b/doc/README_Generic_Autotools.md deleted file mode 100644 index 804d60d03..000000000 --- a/doc/README_Generic_Autotools.md +++ /dev/null @@ -1,50 +0,0 @@ -Autotools Based YaST Packages -============================= - -This is a generic documenation for YaST packages which use autotools (autoconf/automake) -for building the package. - -Building and Installaing --------------------------- - -To build the module run these commands: - - $ make -f Makefile.cvs - $ make - -If you want to rebuild the module later simply run `make` again. - -To install it run: - - $ sudo make install - -Note: This will overwrite the existing module in the system, be carefull when installing -a shared component (library) as it migth break some other modules. - - -Starting the Module -------------------- - -Run the module as root - - # yast2 - -or start the YaST control panel from the desktop menu and then run the appropriate module. - - -Running the Automated Tests ---------------------------- - -To run the testsuite, use the `check` target: - - $ make check - - -Building the Package --------------------- - -To build a package for submitting into [Open Build Service](https://build.opensuse.org/) (OBS) you need to run - - $ make package-local - -in the top level directory. diff --git a/doc/README_Generic_Rake.md b/doc/README_Generic_Rake.md deleted file mode 100644 index 7ce3b4e02..000000000 --- a/doc/README_Generic_Rake.md +++ /dev/null @@ -1,51 +0,0 @@ -Rake Based YaST Packages -======================== - -This is a generic documenation for YaST packages which use `rake` for building the package. - -Building and Installaing ------------------------- - -So far the rake based modules do not need to be built, they are ready to be used just -after the Git clone. - -To install module run: - - $ sudo rake install - -Note: This will overwrite the existing module in the system, be carefull when installing -a shared component (library) as it migth break some other modules. - -Starting the Module -------------------- - -You can [start the installed module](README_Generic_Autotools.md#starting-the-module) -or you can run it directly from the Git checkout without need to install it first - -To run the module directly from the source code, use the `run` Rake task: - - $ rake run - - -Running the Automated Tests ---------------------------- - -To run the testsuite, use the `test:unit` Rake task: - - $ rake test:unit - -To run the tests with code coverage reporting run - - $ COVERAGE=1 rake test:unit - - -For a complete list of tasks, run `rake -T`. - - -Building the Package --------------------- - -To build a package for submitting into [Open Build Service](https://build.opensuse.org/) (OBS) you need to run - - $ rake tarball - diff --git a/doc/README_Template.md b/doc/README_Template.md index ab0486725..fbf494ca1 100644 --- a/doc/README_Template.md +++ b/doc/README_Template.md @@ -36,9 +36,8 @@ This YaST module configures .... Development =========== -This module is developed as part of YaST. See the generic -[development documentation](README_Generic.md#yast-development-documentation) and -[development environment](README_Generic.md#development-environment) description. +This module is developed as part of YaST. See the +[development documentation](http://yastgithubio.readthedocs.org/en/latest/development/). Getting the Sources @@ -59,17 +58,6 @@ Development Environment > otherwise remove this section.* -Installing and Starting the Module -=================================== - - -See [the generic building, installing](README_Generic_Rake.md#building-and-installaing) -and [running](README_Generic_Rake.md#starting-the-module) documentation. - -See [the generic building, installing](README_Generic_Autotools.md#building-and-installaing) -and [running](README_Generic_Autotools.md#starting-the-module) documentation. - - Testing Environment =================== @@ -80,26 +68,6 @@ Testing Environment > so it could be used by the client module.* -Tests and Continuous Integration -================================ - -The tests are also run at a CI server, see -the [generic CI documentation](README_Generic.md#continuous-integration) - - -Building and Submitting the Package -=================================== - -Before submitting any change please read our [contribution -guidelines](CONTRIBUTING.md). - - -See the generic YaST documentation how to -[build](README_Generic_Autotools.md#building-the-package) -[build](README_Generic_Rake.md#building-the-package) -a package and [submit](README_Generic.md#submitting-the-package) it to the Open Build Service (OBS). - - Troubleshooting =============== From 7f62b6b9a49020ac99fa34678b6d0c05472e9abe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ladislav=20Slez=C3=A1k?= Date: Fri, 20 Feb 2015 19:42:57 +0100 Subject: [PATCH 5/6] another review fixes --- README.md | 5 ++--- doc/README_Template.md | 9 +++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b79779322..674719b11 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,8 @@ To get the source code, clone the GitHub repository: $ git clone https://github.com/yast/yast-yast2.git -Alternatively, you can fork the repository and clone your fork. This is most -useful if you plan to contribute into the project and you do not have push -permission to the repository. +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 diff --git a/doc/README_Template.md b/doc/README_Template.md index fbf494ca1..cf0036c8c 100644 --- a/doc/README_Template.md +++ b/doc/README_Template.md @@ -2,7 +2,8 @@ YaST <FOO> Module ======================= - + [![Travis Build](https://travis-ci.org/yast/yast-foo.svg?branch=master)](https://travis-ci.org/yast/yast-foobar) [![Jenkins Build](http://img.shields.io/jenkins/s/https/ci.opensuse.org/yast-foo-master.svg)](https://ci.opensuse.org/view/Yast/job/yast-foo-master/) [![Coverage Status](https://img.shields.io/coveralls/yast/yast-foobar.svg)](https://coveralls.io/r/yast/yast-foobar?branch=master) @@ -47,9 +48,9 @@ To get the source code, clone the GitHub repository: $ git clone https://github.com/yast/.git -Alternatively, you can fork the repository and clone your fork. This is most -useful if you plan to contribute into the project and you do not have push -permission to the repository. +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 ======================= From 85cf1f3452f377fe40805fd9a78d2a2ee1dba597 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ladislav=20Slez=C3=A1k?= Date: Mon, 2 Mar 2015 11:56:23 +0100 Subject: [PATCH 6/6] Update README_Template.md --- doc/README_Template.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/doc/README_Template.md b/doc/README_Template.md index cf0036c8c..b9f58a8a1 100644 --- a/doc/README_Template.md +++ b/doc/README_Template.md @@ -15,6 +15,25 @@ YaST <FOO> Module > *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 ============