nostr/nips
1
0
Fork 0
mirror of https://github.com/nostr-protocol/nips.git synced 2024-12-23 00:45:53 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
2a6074eb87
nips/69.md
Gary R Krause 2a6074eb87 Remove unneeded implementation detail description.
2023-03-04 11:40:07 -05:00

2.4 KiB
Raw Blame History

NIP-69

Source Control Context

draft optional author:garyKrause_

This NIP defines ways source control (git, etc.) context can be stored using nostr. Git is already decentralized, but the contexts around a git repository are largely centralized (PR comments, issue tracking, releases, etc). With the correct approach a nostr relay could store this context using many of the existing NIPs. This NIP defines a new kind, kind: 69, to represent a source control repository. This NIP purposely does not indicate git as a requirement but many of the concepts will be based around git methods of source control. The author hopes that the NIP is flexible enough to accommodate other source control methodologies.

Definition of a Source Control Event

kind: 69 uses tag the b tag to identify the base repository. The value of this tag SHALL be a list of remote source control repository URLs. These URLs MAY be a nostr relay URL or a traditional repository URL. The first URL in this list SHALL be considered the "default" repository URL for the context.

The content of a Source Control Event MUST contain a text description or summary of the base repository. This enables clients that don't specifically handle this kind to display meaningful text in their UI.

{
    ...
  "kind": 69,
  "tags": [
    ["b", <repository url>, <repository url>, ...],
  ],
  "content": <summary or description>,
  ...

Merge Requests

A source control event MAY contain an m tag indicating the event is specific to a merge request. If present, the m tag SHALL define the branch being merged into and the branch being merged in. An event MAY include the URL of the repository being merged from. This could be included when the URL being merged from is not in the b tag of the event or for specificity. When creating a merge request, the content field MAY contain a justification/explanation for the merge. The l tag MAY be included with an m tag. The l tag specifies the relative file path and line number that the event is referencing.

{
    ...
  "kind": 69,
  "tags": [
    ["b", <repository remote identifier (url, etc)>, <repository remote identifier (url, etc)>, ...],
    ["m": <commit hash (branch head) to be merged into>, <commit hash (branch head) to be merged in>, <URL of merging in repository>],
    ["l": <file name/path>, <line number>]
  ],
  "content": <arbitrary string>,
  ...

Issue/Bug Tracking

????