docs: add submitting_a_patchset.md v1 APPLIED

Andrei Khartchenko: 1
 docs: add submitting_a_patchset.md

 1 files changed, 56 insertions(+), 0 deletions(-)

[PATCH] docs: add submitting_a_patchset.md Export this patch

---

add the first of many to be written pieces of documentation for the
scraping portion of this project

 docs/submitting_a_patchset.md | 56 +++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)
 create mode 100644 docs/submitting_a_patchset.md

diff --git a/docs/submitting_a_patchset.md b/docs/submitting_a_patchset.md
new file mode 100644
index 0000000..ef5e2b9
--- /dev/null
+++ b/docs/submitting_a_patchset.md
@@ -0,0 +1,56 @@
+# Submitting a patch
+
+## About patches
+
+On sourcehut, rather than using merge requests, people contribute code
+by emailing a patch (or a set of patches) of their changes to a public
+mailing list.
+
+A patch is a set of changes in text form that can be applied as
+commits to a git repository.
+
+## git-send-email.io
+
+This article takes information from [https://git-send-email.io][gse],
+which includes an interactive tutorial which allows you to practice
+sending patches. If you'd like to practice, you should go there now
+and follow the tutorial. Otherwise, keep reading this article to learn
+what you need to do for numbeo-scraping specifically.
+
+[gse]: https://git-send-email.io
+
+## Submitting a patch to numbeo-scraping
+
+(You'll need to first configure git for email as described on
+git-send-email.io.)
+
+If you haven't yet, clone the repository that you want to edit. Here's
+how you clone the main numbeo-scraping repository: `git clone
+https://git.sr.ht/~akspecs/numbeo-scraping`
+
+Set the default email address: `git config sendemail.to
+'~akspecs/numbeo-scraping-dev@lists.sr.ht'`
+
+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 `~akspecs/numbeo-scraping-dev@lists.sr.ht`.
+
+[on matrix]: https://matrix.to/#/#2021_fall_cs195_general:matrix.org
-- 
2.34.0