github-review icon indicating copy to clipboard operation
github-review copied to clipboard

What's the Auth section of the README about?

Open DivineDominion opened this issue 4 years ago • 6 comments

It's about this part:

Add a line to your auth source files with your login and token: [...]

Bluntly, I just don't know what "my auth source files" refers to in this context :)

DivineDominion avatar Nov 22 '21 09:11 DivineDominion

+1 to this.

jacobpmeyer avatar Dec 09 '21 02:12 jacobpmeyer

I have a conflict of interest now as I am contributing to this package but also developing a new version of this same package https://github.com/wandersoncferreira/code-review which should have this same issue. I added the usual path to the authinfo file here https://github.com/wandersoncferreira/code-review#auth-1

could you try and see if this is enough documentation to make the package work? (either GitHub-review or code-review)

wandersoncferreira avatar Dec 10 '21 13:12 wandersoncferreira

In the meantime, I got lucky and was tutored excellently by @ilemming on twitter: https://twitter.com/iLemming/status/1463599279457673220

A segue about the file might indeed be useful in the README.

@wandersoncferreira Your example should be enough to get people going. I noticed the path is only mentioned for GitLab, not GitHub right above.

DivineDominion avatar Dec 10 '21 13:12 DivineDominion

Good point @DivineDominion . I will mention this tweet link too :)

wandersoncferreira avatar Dec 10 '21 13:12 wandersoncferreira

https://github.com/wandersoncferreira/code-review#setup let me know.

wandersoncferreira avatar Dec 10 '21 13:12 wandersoncferreira

LGTM 👍

DivineDominion avatar Dec 10 '21 15:12 DivineDominion