aboutsummaryrefslogtreecommitdiff
path: root/src/public/contributing.html
blob: 1cf7702fc5c7bc16cd72744c0ab1b0b1d6e04c84 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<p>
  Unless stated otherwise, the projects you can find on
  my <a href="https://git.mssola.com">Git instance</a> or on
  my <a href="https://github.com/mssola">Github profile</a> are basically
  personal projects. That is to say that I don't expect contributions, to be
  honest. But regardless of that, patches are always welcome :-) If you want to
  report something odd or suggest an improvement,
  just <a href="mailto:mssola@mssola.com" title="mssola@mssola.com">send me an
  email</a>. Otherwise, if you have some changes that you would want to
  contribute in, you should know that my preferred way to accept patches is via
  email. That is:
<p>

<ul>
  <li>
    Use git's native commands (e.g. <code>commit</code>, <code>rebase</code>, et
    al) to build a list of commits you'd like me to review.
  </li>

  <li>
    Write <a href="https://chris.beams.io/posts/git-commit/" title="good commit
    message">good commit messages</a>. Extra points if they are in the style of
    the <a href="https://docs.kernel.org/process/submitting-patches.html"
    title="Linux kernel">Linux kernel</a>.
  </li>

  <li>
    Use the <code>--cover-letter</code> option
    in <a href="https://git-scm.com/docs/git-format-patch" title="git
    format-patch">git format-patch</a> if you are sending multiple commits, and
    explain to me why I should merge your changes there.
  </li>

  <li>
    Send everything via <a href="https://git-scm.com/docs/git-send-email"
    title="git send-email">git send-email</a> and expect some back and forth via
    email.
  </li>
</ul>

<p>
If you are crazy enough to have a fork of some of my projects, then you can also
consider using git's native <a href="https://git-scm.com/docs/git-request-pull"
title="git-request-pull manual">request-pull</a> command.
</p>

<p>
Otherwise, if all of this git native shenanigans is beyond your alley of
expertise, then sending me a Github PR might not be too bad of an idea. That
being said, I would still merge everything manually and I'd still possibly
change the commit message if I feel like it could be improved but I don't want
to bother you with new versions just because of the git commit message.
</p>

<p>
Last but not least, I adhere to
the <a href="https://docs.kernel.org/process/submitting-patches.html#developer-s-certificate-of-origin-1-1"
title="Description of the Developer's Certificate of Origin 1.1">Developer's
Certificate of Origin 1.1</a>. Thus, you must sign off all your commits if you
want me to pull any of your changes.
</p>

<p>
If your contribution was in any way developed with the aid of an LLM, I'd also
like to know it, as I'd appreciate the honesty and I would tacke the review
process differently.
</p>