Add submitting a patchset documentation

Cadence Ember 3 years ago
parent 6fd9e52d95
commit 450c38a3fd
No known key found for this signature in database
GPG Key ID: 128B99B1B74A6412
  1. 2
  2. 55
      docs/Submitting a

.gitignore vendored

@ -1,5 +1,5 @@
# Emacs crud files
# VSCode crud files

@ -0,0 +1,55 @@
# Submitting a patchset
## About patchsets
On sourcehut, rather than using merge requests, people contribute code
by emailing a patchset of their changes to a public mailing list.
A patchset is a set of changes in text form that can be applied as
commits to a git repository.
This article takes information from [][gse], which
includes an interactive tutorial which allows you to practise sending
patchsets. If you'd like to practise, you should go there now and follow
the tutorial. Otherwise, keep reading this article to learn what you
need to do for Bibliogram specifically.
## Submitting a patchset to Bibliogram
(You'll need to first configure git for email as described on
If you haven't yet, clone the repository that you want to edit. Here's
how you clone the main Bibliogram repository: `git clone`
Set the default email address: `git config
Create a topic branch to work on: `git checkout -b my-cool-changes`
Make the changes you want to make using a text editor.
Add and commit your changes to the topic branch.
Email the patch to the mailing list: `git send-email master`
(`master` here represents which commits you want to send. Everything
_after_ the specified revision will be sent, so `master` will send
everything on your topic branch. You can also try `HEAD^` to send the
latest commit, `HEAD^3` to send the latest 3, or `abcdef1` to send
everything after a specific commit.)
If you're asked to make changes, it's okay to use `git commit --amend`
and `git rebase` if you wish to. When you've made the changes, use `git
send-email -v2 master`. If you have to go back for a third attempt, use
`-v3`, and so on.
If you run into problems, you can ask for help [on matrix] or by
composing an email to `~cadence/`.
[on matrix]: