unofficial mirror of guix-patches@gnu.org 
 help / color / mirror / code / Atom feed
From: Leo Famulari <leo@famulari.name>
To: 44913@debbugs.gnu.org
Subject: [bug#44913] [PATCH] gnu: ruby-rubocop-ast: Update to 1.2.0.
Date: Fri, 4 Dec 2020 19:01:33 -0500	[thread overview]
Message-ID: <X8rN3TkB0P+CiKbW@jasmine.lan> (raw)
In-Reply-To: <42cadfd1-f719-ac23-924b-c964775dad1d@mailbox.org>

On Fri, Nov 27, 2020 at 11:22:44PM +0100, Tomás Ortín Fernández via Guix-patches via wrote:
> * gnu/packages/ruby.scm (ruby-rubocop-ast): Update to 1.2.0.

Thanks!

>      (source
>       (origin
> -       (method git-fetch)               ;no test suite in distributed gem
> -       (uri (git-reference
> -             (url "https://github.com/rubocop-hq/rubocop-ast")
> -             (commit (string-append "v" version))))
> -       (file-name (git-file-name name version))
> +       (method url-fetch)
> +       (uri (rubygems-uri "rubocop-ast" version))
>         (sha256
>          (base32
> -         "1ycf6qcj8nbzk2js72priim4642lkn56w5kbny1nlryjkckxgm04"))))
> +         "0q0kdi89ad7dd1xmzrdf5ikk32bllzr68hf4x8fd7azcv5jnch2l"))))
>      (build-system ruby-build-system)
>      (arguments
> -     `(#:test-target "spec"
> -       #:phases (modify-phases %standard-phases
> -                  (add-after 'unpack 'disable-bundler
> -                    (lambda _
> -                      (substitute* "Rakefile"
> -                        (("Bundler\\.setup.*") "nil\n"))
> -                      #t))
> -                  (replace 'replace-git-ls-files
> -                    (lambda _
> -                      (substitute* "rubocop-ast.gemspec"
> -                        (("`git ls-files(.*)`" _ files)
> -                         (format #f "`find ~a -type f| sort`" files)))
> -                      #t)))))
> +     '(#:tests? #f)) ; tests not included in gem

The commit message should describe the changes to the code.

For example, I might write it this way:

------
gnu: ruby-rubocop-ast: Update to 1.2.0.

* gnu/packages/ruby.scm (ruby-rubocop-ast): Update to 1.2.0.
[source]: Fetch source from rubygems.
[arguments]: Remove obsolete 'disable-bundler' phase. Skip the test suite.
------

This helps communicate your intentions to reviewers (and everyone else).

For example, why does the patch remove the 'disable-bundler' phase? If that
phase is no longer needed, it helps to describe it as obsolete in the commit
message.

The code comment about why the tests are skipped is really useful, for the same
reason. But we can't add comments about code that is removed :)

Does that make sense? Can you send a revised patch with a complete commit
message? It's fine to copy what I wrote if it is accurate.




  reply	other threads:[~2020-12-05  0:02 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-27 22:22 [bug#44913] [PATCH] gnu: ruby-rubocop-ast: Update to 1.2.0 Tomás Ortín Fernández via Guix-patches via
2020-12-05  0:01 ` Leo Famulari [this message]
2021-02-25 22:53 ` bug#44913: " Björn Höfling

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=X8rN3TkB0P+CiKbW@jasmine.lan \
    --to=leo@famulari.name \
    --cc=44913@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).