diff options
author | Robert Roth <robert.roth.off@gmail.com> | 2018-08-26 23:48:51 +0000 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2018-08-26 23:48:51 +0000 |
commit | 4ed4b4fd6ad5aed3a16934450c09c265a22e89b7 (patch) | |
tree | d7adb0fb56f3b5e0c305df6072bd191ad0beb2ac | |
parent | 369cb702e48aaa8b36c963b43399c1bca606d04e (diff) | |
download | gtk+-4ed4b4fd6ad5aed3a16934450c09c265a22e89b7.tar.gz |
docs: README.commits converted to markdown
-rw-r--r-- | CONTRIBUTING.md | 6 | ||||
-rw-r--r-- | README.commits.md (renamed from README.commits) | 17 |
2 files changed, 11 insertions, 12 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 318c1ce68e..3326f99043 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,9 +48,9 @@ $ ninja ``` **Note**: For information about submitting patches and pushing changes -to Git, see the `README.md` and `README.commits` files. In particular, +to Git, see the [README.md](./README.md) and [README.commits.md](./README.commits.md) files. In particular, don't, under any circumstances, push anything to Git before reading and -understanding `README.commmits`. +understanding [README.commits.md](./README.commits.md). Typically, you should work on your own branch: @@ -60,6 +60,6 @@ $ git checkout -b your-branch Once you've finished working on the bug fix or feature, push the branch to the Git repository and open a new merge request, to let the GTK -maintainers review your contribution. The [CODE-OWNERS](./docs-CODE-OWNERS) +maintainers review your contribution. The [CODE-OWNERS](./docs/CODE-OWNERS) document contains the list of core contributors to GTK and the areas for which they are responsible. diff --git a/README.commits b/README.commits.md index f6e830a2ce..c5354b64d3 100644 --- a/README.commits +++ b/README.commits.md @@ -7,25 +7,23 @@ avoid unnecessary breakage, and to take advantage of the knowledge about GTK+ that has been built up over the years, we'd like to ask people committing to GTK+ to follow a few rules: -0) Ask first. If your changes are major, or could possibly break existing +0. Ask first. If your changes are major, or could possibly break existing code, you should always ask. If your change is minor and you've been working on GTK+ for a while it probably isn't necessary to ask. But when in doubt, ask. Even if your change is correct, somebody may know a better way to do things. - If you are making changes to GTK+, you should be subscribed to gtk-devel-list@gnome.org. (Subscription address: gtk-devel-list-request@gnome.org.) This is a good place to ask about intended changes. - #gtk+ on GIMPNet (irc.gimp.org, irc.us.gimp.org, irc.eu.gimp.org, ...) is also a good place to find GTK+ developers to discuss changes with, however, email to gtk-devel-list is the most certain and preferred method. -1) Ask _first_. +0. Ask _first_. -2) With git, we no longer maintain a ChangeLog file, but you are expected +0. With git, we no longer maintain a ChangeLog file, but you are expected to produce a meaningful commit message. Changes without a sufficient commit message will be reverted. See below for the expected format of commit messages. @@ -39,13 +37,13 @@ Notes: * The expected format for git commit messages is as follows: -=== begin example commit === +``` Short explanation of the commit Longer explanation explaining exactly what's changed, whether any external or private interfaces changed, what bugs were fixed (with bug tracker reference if applicable) and so forth. Be concise but not too brief. -=== end example commit === +``` - Always add a brief description of the commit to the _first_ line of the commit and terminate by two newlines (it will work without the @@ -60,8 +58,8 @@ tracker reference if applicable) and so forth. Be concise but not too brief. punctuation and capital letters where appropriate. Normally, for patches sent to a mailing list it's copied from there. - - When committing code on behalf of others use the --author option, e.g. - git commit -a --author "Joe Coder <joe@coder.org>" and --signoff. + - When committing code on behalf of others use the `--author` option, e.g. + `git commit -a --author "Joe Coder <joe@coder.org>"` and `--signoff`. Owen Taylor @@ -70,3 +68,4 @@ Owen Taylor Matthias Clasen 31 Mar 2009 + |