-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #346 from yast/shared_README
Added generic README files
- Loading branch information
Showing
3 changed files
with
136 additions
and
93 deletions.
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 | ||
| ============================ | ||
|
|
||
| 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. |
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 | ||
| ======================= | ||
|
|
||
| <!-- 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) | ||
| [](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. |