~whereiseveryone/public-inbox

wiki: Document how to use todo.sr.ht v1 APPLIED

Dhruvin Gandhi <contact@dhruvin.dev>
1 year, 8 months ago 
Dhruvin Gandhi: 1
 Document how to use todo.sr.ht

 2 files changed, 23 insertions(+), 1 deletions(-)
Export patchset (mbox)
How do I use this?

Copy & paste the following snippet into your terminal to import this patchset into git: 

curl -s https://lists.sr.ht/~whereiseveryone/public-inbox/patches/28348/mbox | git am -3
Learn more about email & git
Reply to thread View this thread in the archives

[PATCH wiki] Document how to use todo.sr.ht Export this patch

Dhruvin Gandhi <contact@dhruvin.dev>
1 year, 8 months ago 
Implements: https://todo.sr.ht/~whereiseveryone/guixrus/10
---
 index.md    |  3 ++-
 todosrht.md | 21 +++++++++++++++++++++
 2 files changed, 23 insertions(+), 1 deletion(-)
 create mode 100644 todosrht.md

diff --git a/index.md b/index.md
index e709120..cd4850b 100644
--- a/index.md
+++ b/index.md
@@ -3,5 +3,6 @@ title: wiki
toc: false
---

[tips and tricks](./tipsandtricks.md) | [wish list](./wishlist.md) | [contributing](./contributing.md)
[tips and tricks](./tipsandtricks.md) | [wish list](./wishlist.md) |
[contributing](./contributing.md) | [using todo.sr.ht](./todosrht.md)

diff --git a/todosrht.md b/todosrht.md
new file mode 100644
index 0000000..6302b6d
--- /dev/null
+++ b/todosrht.md
@@ -0,0 +1,21 @@
## Recommendations for using [todo.sr.ht/~whereiseveryone/guixrus](https://todo.sr.ht/~whereiseveryone/guixrus)

- A ticket should be a unit of work.
- A ticket should aptly describe the changes proposed in title. Just like a
  commit message title would (usually <50 chars, but not mandatory).
- A ticket description may include useful resources like links to releases,
  change-log, link to or an essence of some previous informal conversation that
  may provide context for which the ticket is created.
- A ticket should have one-to-one relation to a single commit (to be done) if
  possible. This helps define the criteria of completion. This also makes
  associating tickets with commits and patches simple. Contributors can have
  `Fixes: https://todo.sr.ht/~whereiseveryone/guixrus/3` in the commit trailers
  to have the ticket automatically be closed when the containing patch[set]
  gets applied.[Read
  more](https://man.sr.ht/git.sr.ht/#referencing-tickets-in-git-commit-messages).
  - If the above can't be met for a given task, it should be broken down into
    several (sub)tickets, with the last ticket being the parent ticket of the
    former. The parent ticket should have links to all (sub)tickets, with
    checkboxes. SourceHut will add link to the parent ticket to all
    (sub)tickets. This helps everyone work on a long term goal with progress
    tracking and work distribution/assignment.
-- 
2.34.1