diff options
author | Maxim Cournoyer <maxim.cournoyer@gmail.com> | 2021-04-08 15:47:00 -0400 |
---|---|---|
committer | Maxim Cournoyer <maxim.cournoyer@gmail.com> | 2021-04-08 15:47:00 -0400 |
commit | 533a893cc6b03f100566760d6e0c8e0500ed7082 (patch) | |
tree | 0ecbf89895a400c43d16bb1f6539f1a88aeaa4cf /doc/contributing.texi | |
parent | 6a2546f92d07df04e5d700924edd027ed1e2ef11 (diff) | |
parent | c762df54786fd6f005f3b5307323f1d2df3cbf0b (diff) | |
download | guix-533a893cc6b03f100566760d6e0c8e0500ed7082.tar.gz guix-533a893cc6b03f100566760d6e0c8e0500ed7082.zip |
Merge branch 'master' into staging
Conflicts:
.guix-authorizations
gnu/ci.scm
gnu/packages/base.scm
gnu/packages/databases.scm
gnu/packages/gnome.scm
gnu/packages/gtk.scm
gnu/packages/imagemagick.scm
gnu/packages/password-utils.scm
gnu/packages/python-xyz.scm
gnu/packages/web-browsers.scm
Diffstat (limited to 'doc/contributing.texi')
-rw-r--r-- | doc/contributing.texi | 25 |
1 files changed, 19 insertions, 6 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi index 3baedb0654..9a09de93e6 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -126,10 +126,10 @@ Store}, for information about this), usually @file{/var}. Note that you will probably not run @command{make install} at the end (you don't have to) but it's still important to pass the right @code{localstatedir}. -Finally, you have to invoke @code{make check} to run tests -(@pxref{Running the Test Suite}). If anything -fails, take a look at installation instructions (@pxref{Installation}) -or send a message to the @email{guix-devel@@gnu.org, mailing list}. +Finally, you have to invoke @code{make && make check} to build Guix and +run the tests (@pxref{Running the Test Suite}). If anything fails, take +a look at installation instructions (@pxref{Installation}) or send a +message to the @email{guix-devel@@gnu.org, mailing list}. From there on, you can authenticate all the commits included in your checkout by running: @@ -432,7 +432,7 @@ upstream source. @subsection Package Naming @cindex package name -A package has actually two names associated with it: +A package actually has two names associated with it. First, there is the name of the @emph{Scheme variable}, the one following @code{define-public}. By this name, the package can be made known in the Scheme code, for instance as input to another package. Second, there is @@ -445,6 +445,14 @@ the project name chosen upstream, with underscores replaced with hyphens. For instance, GNUnet is available as @code{gnunet}, and SDL_net as @code{sdl-net}. +A noteworthy exception to this rule is when the project name is only a +single character, or if an older maintained project with the same name +already exists---regardless of whether it has already been packaged for +Guix. Use common sense to make such names unambiguous and meaningful. +For example, Guix's package for the shell called ``s'' upstream is +@code{s-shell} and @emph{not} @code{s}. Feel free to ask your fellow +hackers for inspiration. + We do not add @code{lib} prefixes for library packages, unless these are already part of the official project name. But @pxref{Python Modules} and @ref{Perl Modules} for special rules concerning modules for @@ -1016,7 +1024,6 @@ your @code{operating-system} configuration: (service qemu-binfmt-service-type (qemu-binfmt-configuration (platforms (lookup-qemu-platforms "arm" "aarch64")) - (guix-support? #t))) @end lisp Then reconfigure your system. @@ -1374,6 +1381,12 @@ you're confident, it's OK to commit. That last part is subject to being adjusted, allowing individuals to commit directly on non-controversial changes on parts they’re familiar with. +In order to reduce the possibility of mistakes, committers will have +their Savannah account removed from the Guix Savannah project and their +key removed from @file{.guix-authorizations} after 12 months of +inactivity; they can ask to regain commit access by emailing the +maintainers, without going through the vouching process. + One last thing: the project keeps moving forward because committers not only push their own awesome changes, but also offer some of their time @emph{reviewing} and pushing other people's changes. As a committer, |