Skip to content

Commit

Permalink
CONTRIBUTING.md: contributors should update version+changes
Browse files Browse the repository at this point in the history
As has been
- long the actual practice
- proposed in https://lists.opensuse.org/yast-devel/2016-08/msg00033.html
- reviewed in yast/yast-yast2#490
  • Loading branch information
mvidner committed Aug 19, 2016
1 parent d7546cc commit 48628cd
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions CONTRIBUTING.md
Expand Up @@ -3,7 +3,7 @@ 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.
ensure the process is effective and pleasant both for you and the YaST maintainers.

There are two main forms of contribution: reporting bugs and performing code
changes.
Expand All @@ -17,13 +17,11 @@ 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.suse.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).

We can't guarantee that every bug will be fixed, but we'll try.

Code Changes
------------

Expand All @@ -44,25 +42,29 @@ follows:
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
4. Update the package version (in `packages/*.spec`, usually by
`rake version:bump`) and add a new entry to the `package/*.changes` file
(by `osc vc package`).
For bigger changes or changes which need longer discussion it is advised to
add this as a separate last commit so it can be easily updated when another
change is merged in the meantime.

5. 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. Publish the branch and create a pull request.

6. YaST developers will review your change and possibly point out issues.
7. 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.
8. 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
Expand Down

0 comments on commit 48628cd

Please sign in to comment.