You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I recommend opening an issue before creating a PR.
6
+
7
+
1. You must create a directory with the name of the command.
8
+
2. Inside this directory, you must create a `doc.go` with a summary of the git command (based of the help of this command).
9
+
3. You must define all the options manually inside [descriptions.json](https://github.com/ldez/go-git-cmd-wrapper/blob/main/internal/descriptions.json).
10
+
4. Optionally, you could create a `<command>_custom.go` inside the command directory to add option(s) which cannot be generated.
11
+
5. You must run `make generate` to generate the `<command>_gen.go` related to the `descriptions.json`.
12
+
6. Inside the command directory, you must add test `<command>_test.go`.
13
+
7. You must add examples inside [example_test.go](https://github.com/ldez/go-git-cmd-wrapper/blob/main/git/example_test.go)
14
+
15
+
Additionally, I use [regular expressions](https://github.com/ldez/go-git-cmd-wrapper/blob/main/internal/readme.adoc) to help with the `descriptions.json`,
16
+
but the extracted information from the doc or the help is not useable directly,
0 commit comments