back round 1 view raw

contributing.md: simplify `jj` sign-off instructions #465

merged

opened by

ilyagr.bsky.social 4 months ago targeting master from ilyagr.bsky.social/core: jj-sign-off

This functionality seems to be available since jj 0.29.

Signed-off-by: Ilya Grigoriev ilyagr@users.noreply.github.com

options

unified split

Changed files

+8 -15

docs

contributing.md

+8 -15

docs/contributing.md

···

       115
       115
        
       If you're submitting a PR with multiple commits, make sure each one is

     

       116
       116
        
       signed.

     

       117
       117
        
       

     

       118
       118
       -
       For [jj](https://jj-vcs.github.io/jj/latest/) users, you can add this to

     

       119
       119
       -
       your jj config:

     

       118
       118
       +
       For [jj](https://jj-vcs.github.io/jj/latest/) users, you can run the following command

     

       119
       119
       +
       to make it sign off commits in the tangled repo:

     

       120
       120
        
       

     

       121
       121
       -
       ```

     

       122
       122
       -
       ui.should-sign-off = true

     

       123
       123
       -
       ```

     

       124
       124
       -
       

     

       125
       125
       -
       and to your `templates.draft_commit_description`, add the following `if`

     

       126
       126
       -
       block:

     

       127
       127
       -
       

     

       128
       128
       -
       ```

     

       129
       129
       -
         if(

     

       130
       130
       -
           config("ui.should-sign-off").as_boolean() && !description.contains("Signed-off-by: " ++ author.name()),

     

       131
       131
       -
           "\nSigned-off-by: " ++ author.name() ++ " <" ++ author.email() ++ ">",

     

       132
       132
       -
         ),

     

       121
       121
       +
       ```shell

     

       122
       122
       +
       # Safety check, should say "No matching config key..."

     

       123
       123
       +
       jj config list templates.commit_trailers

     

       124
       124
       +
       # The command below may need to be adjusted if the command above returned something.

     

       125
       125
       +
       jj config set --repo templates.commit_trailers "format_signed_off_by_trailer(self)"

     

       133
       126
        
       ```

     

       134
       127
        
       

     

       135
       128
        
       Refer to the [jj

     

       136
       136
       -
       documentation](https://jj-vcs.github.io/jj/latest/config/#default-description)

     

       129
       129
       +
       documentation](https://jj-vcs.github.io/jj/latest/config/#commit-trailers)

     

       137
       130
        
       for more information.