commit 2c6865cb6b18b2b30edf48a53240c8103f686fdc · veryroundbird.house/core

+54
docs/contributing.md
···

       77
       77
        
       

     

       78
       78
        
       We'll use the issue thread to discuss and refine the idea before moving

     

       79
       79
        
       forward.

     

       80
       80
       +
       

     

       81
       81
       +
       ## developer certificate of origin (DCO)

     

       82
       82
       +
       

     

       83
       83
       +
       We require all contributors to certify that they have the right to

     

       84
       84
       +
       submit the code they're contributing. To do this, we follow the

     

       85
       85
       +
       [Developer Certificate of Origin

     

       86
       86
       +
       (DCO)](https://developercertificate.org/).

     

       87
       87
       +
       

     

       88
       88
       +
       By signing your commits, you're stating that the contribution is your

     

       89
       89
       +
       own work, or that you have the right to submit it under the project's

     

       90
       90
       +
       license. This helps us keep things clean and legally sound.

     

       91
       91
       +
       

     

       92
       92
       +
       To sign your commit, just add the `-s` flag when committing:

     

       93
       93
       +
       

     

       94
       94
       +
       ```sh

     

       95
       95
       +
       git commit -s -m "your commit message"

     

       96
       96
       +
       ```

     

       97
       97
       +
       

     

       98
       98
       +
       This appends a line like:

     

       99
       99
       +
       

     

       100
       100
       +
       ```

     

       101
       101
       +
       Signed-off-by: Your Name <your.email@example.com>

     

       102
       102
       +
       ```

     

       103
       103
       +
       

     

       104
       104
       +
       We won't merge commits if they aren't signed off. If you forget, you can

     

       105
       105
       +
       amend the last commit like this:

     

       106
       106
       +
       

     

       107
       107
       +
       ```sh

     

       108
       108
       +
       git commit --amend -s

     

       109
       109
       +
       ```

     

       110
       110
       +
       

     

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

     

       112
       112
       +
       signed.

     

       113
       113
       +
       

     

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

     

       115
       115
       +
       your jj config:

     

       116
       116
       +
       

     

       117
       117
       +
       ```

     

       118
       118
       +
       ui.should-sign-off = true

     

       119
       119
       +
       ```

     

       120
       120
       +
       

     

       121
       121
       +
       and to your `templates.draft_commit_description`, add the following `if`

     

       122
       122
       +
       block:

     

       123
       123
       +
       

     

       124
       124
       +
       ```

     

       125
       125
       +
         if(

     

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

     

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

     

       128
       128
       +
         ),

     

       129
       129
       +
       ```

     

       130
       130
       +
       

     

       131
       131
       +
       Refer to the [jj

     

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

     

       133
       133
       +
       for more information.