Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: Document the internals #974

Open
tedivm opened this issue Sep 30, 2019 · 2 comments
Open

Feature Request: Document the internals #974

tedivm opened this issue Sep 30, 2019 · 2 comments

Comments

@tedivm
Copy link

tedivm commented Sep 30, 2019

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.

@omgjlk
Copy link
Collaborator

omgjlk commented Sep 30, 2019

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!

@tedivm
Copy link
Author

tedivm commented Sep 30, 2019

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants