README: overhaul file structure #811

bmeneg · 2022-02-22T15:03:10Z

In order to make the README information more clear this patch overhaul
its structure and update its content to match the current state of the
tool.

Signed-off-by: Bruno Meneguele [email protected]

Fix #777 .
This PR semantically depends on PR #809 being merged, otherwise some recommendations won't work as expected.

bmeneg · 2022-02-22T15:06:14Z

@zaquestion once PR #809 and this one here are merged, could you update the project "About" text dropping the "Lab wraps Git and Hub" part? I don't have permission to do so.

codecov · 2022-02-22T15:13:06Z

Codecov Report

Merging #811 (3371ecd) into master (f8ed118) will increase coverage by 0.80%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #811      +/-   ##
==========================================
+ Coverage   55.43%   56.24%   +0.80%     
==========================================
  Files          77       77              
  Lines        5771     5752      -19     
==========================================
+ Hits         3199     3235      +36     
+ Misses       2277     2227      -50     
+ Partials      295      290       -5

Impacted Files	Coverage Δ
cmd/clone.go	`71.87% <0.00%> (-2.20%)`	⬇️
cmd/issue.go	`68.18% <0.00%> (ø)`
cmd/mr_checkout.go	`81.96% <0.00%> (ø)`
cmd/fork.go	`63.15% <0.00%> (+5.26%)`	⬆️
cmd/root.go	`63.52% <0.00%> (+5.73%)`	⬆️
cmd/mr_discussion.go	`85.07% <0.00%> (+28.35%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 54a8737...3371ecd. Read the comment docs.

README.md

zaquestion · 2022-02-22T20:13:12Z

Might be worth adding a table of contents while you're at it, Readme has gotta a lot longer since the early days

bmeneg · 2022-02-22T22:54:38Z

Oh, sure, I'll add the toc :)

bmeneg · 2022-02-23T13:39:18Z

@zaquestion I just realized that GitHub itself has a table of contents in the left of readme's filename:

It was released mid last year. With that I think we don't really need to have a specific toc in our doc.

bmeneg · 2022-02-23T13:51:14Z

Lol.. I'm pretty sure a README file change don't affect a build testing:

409 {message: {base: [PG::QueryCanceled: ERROR:  canceling statement due to statement timeout

And I'm almost sure it's not client's problem (error 40x) .. hahaha.

zampierilucas · 2022-02-23T13:59:01Z

@zaquestion I just realized that GitHub itself has a table of contents in the left of readme's filename:

It was released mid last year. With that I think we don't really need to have a specific toc in our doc.

Does GitLab support that? If not, It's not worth the work IMO, as we are moving soon™ to GitLab.

bmeneg · 2022-02-23T14:01:51Z

GitLab requires an explicit toc with [[_TOC_]].
Since it's different for github we can change it once we migrate to GitLab.

README.md

zaquestion · 2022-02-24T00:13:51Z

@zaquestion once PR #809 and this one here are merged, could you update the project "About" text dropping the "Lab wraps Git and Hub" part? I don't have permission to do so.

Can do, feel free to email me if I forget / fail to notice this merge.

bmeneg · 2022-02-24T16:25:38Z

@zaquestion once PR #809 and this one here are merged, could you update the project "About" text dropping the "Lab wraps Git and Hub" part? I don't have permission to do so.

Can do, feel free to email me if I forget / fail to notice this merge.

:-) ack! Will do.

In order to make the README information more clear this patch overhaul its structure and update its content to match the current state of the tool. Signed-off-by: Bruno Meneguele <[email protected]>

prarit

LGTM!

bmeneg · 2022-03-02T18:08:58Z

@zaquestion, just fyi.. you can now update project's description. I'm hitting the merge button right now.

bmeneg requested review from prarit, zampierilucas and zaquestion February 22, 2022 15:03

bmeneg mentioned this pull request Feb 22, 2022

issue: add alias for just i? #810

Closed

zampierilucas reviewed Feb 22, 2022

View reviewed changes