Open bear-jordan opened 1 year ago
Hi there, apologies for not responding sooner. If you're still willing to work on this, that sounds like a wonderful contribution!
We don't have any documented contribution guidelines (at least that I know of). The things I generally recommend in any context are:
f
and documenting a function g
should be separate PRs but documenting f
and documenting g
could be together since review comments may be applicable to both.hello, is someone working on this already? if not I'd love to work on it. I'm new to opensource so any guidelines on how to go about it would help, thanks a lot!
Hi, I am not working on it. Not sure if anyone else has picked it up though. Hope it goes well!
Go for it!
Hi, I would like to add coded examples for each method in the documentation to provide clear examples of implementation for new users. Would y'all have any interest in this project?
Right now, the documentation for an individual method looks like this...
At the end of the project, the documentation would include the coded section as seen below.
To complete the project, I plan to adapt the examples from the unit tests. I think it should be pretty straight forward!
Also, I looked for contribution guidelines but haven't seen any–have these been developed? Sorry if I missed them.
Best, Bear Jordan