github3.py icon indicating copy to clipboard operation
github3.py copied to clipboard

Feature Request: Document the internals

Open tedivm opened this issue 5 years ago • 2 comments

I love this library and use it for several different projects. There have been a few times where I've had to open issues, and the team working on this has always been great.

That being said I'd love to help more, possibly by opening PRs rather than issues. The place I get stuck at those is navigating the internals of the projects- the number of internal classes definitely leaves me running around, and quite frankly I have no idea how to use the "cassettes" system or run tests locally.

I realized that if there was more documentation I might be able to help more, which has prompted me to open this request.

tedivm avatar Sep 30 '19 22:09 tedivm

I think this is fair feedback. I had to do the same, dig through and follow code around, and got some help. It's not great that we don't have anything to document it. Add to that, the whole code base went through a re-org not too long ago so things definitely got shuffled a bit. I'm happy to help guide, or approve PRs to document things. I don't know how much documentation I'll generate in the short term though!

omgjlk avatar Sep 30 '19 22:09 omgjlk

No worries- and as I said, I'm happy to help as well. I really appreciate the work that's gone into this library, and it has really helped me build out some fun tools.

tedivm avatar Sep 30 '19 22:09 tedivm