Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
93 lines (70 sloc) 4.27 KB

This project does not accept GitHub Pull Requests. This is done intentionally, as it allows us to maintain the entire history of submitted patches in SIT itself. Any opened Pull Requests will be closed. The contributors will be asked to use our own merge request procedure (see below).

Our goal is to encourage frictionless contributions to the project. In order to achieve that, we use Unprotocols' C4 process as an inspiration. Please read it, it will answer a lot of questions. Our goal is to merge patches as quickly as possible and make new stable releases regularly.

In a nutshell, this means:

  • We merge patches rapidly (try!)
  • We are open to diverse ideas
  • We prefer code now over consensus later

It is highly recommended to watch Pieter Hintjens' talk on building open source communities as well as read his book on the same matter.

Submitting an issue

According to C4's development process, the issue should describe a documented and provable. What this means is that an issue should strive to have a clear, understandable problem statement. Just like a patch, it SHOULD be titled "Problem: ..." and have a detailed description describing evidence behind it, be it a bug or a feature request, or a longer term "exploratory" issue.

Unlike C4, we're not using GitHub (or any other well-known platform) for issues. Instead, we're using SIT itself. Please refer to README section that covers this process.

Preparing a patch

According to patch requirements, the patch should be a minimal and accurate answer to exactly one identified and agreed problem. A patch commit message must consist of a single short (less than 50 characters) line stating the problem ("Problem: ...") being solved, followed by a blank line and then the proposed solution ("Solution: ...").

Problem: short problem statement

Optional longer explanation of the problem that this patch
addresses, giving necessary details for the reader to be
able to understand it better.

Solution: explanation of the solution to the problem. Could
be longer than one line.

Preparing a merge request

Once you have a branch (BRANCH) with your patch ready:

Run sit mr <BRANCH> and either use the suggested text as is or edit it. Please keep in mind that currently it expects the first line of your commit to be a one-line problem statement (it will copy it to the summary), the second line to be empty and the rest to be a description (you can see an example right above).

If you would prefer to attach your merge request to an existing issue (for example, there's a bug report, or a problem statement already recorded), simply extend the above command to this:

sit mr <BRANCH> <ISSUE-ID>

Then, at the end, it will give you a command line to copy-paste to send the request out.

Alternatively, you can use a manual route (for the truly brave ones):

  1. Create a new issue: sit issue and take a note of the generated ID.
  2. Generate patches: rm -rf git && git format-patch $(git merge-base --fork-point master <BRANCH>)..<BRANCH> -o git (cleaning git assures there are no leftover patches)
  3. Edit temporary text file to supply the one-line summary (such as Problem: ...). It is important to name the file text and not something else
  4. Take ID from the first step and run sit record -t SummaryChanged ID text
  5. Edit temporary text file to prepare details. Provide detailed information for your patch so that others can fully understand it. It is a good etiquette to have one or a few paragraphs.
  6. Take ID from the first step and run sit record -t DetailsChanged,MergeRequested ID text git/*.patch
  7. Refer to this instruction to send the merge request to the upstream.

Alternatively, if the problem was already stated in some issue, it also makes sense to add a merge request directly to that issue (ID1): sit record -t MergeRequested,Commented ID1 text git/*.patch and follow sending instructions in Step 5.