django-organizations icon indicating copy to clipboard operation
django-organizations copied to clipboard

Documentation Volunteer

Open satcomjimmy opened this issue 1 year ago • 4 comments

I've never contributed to an open source project before. This one seems to fit my needs nicely but the docs seem out of date. I'd like to help update them as I work on integrating it to my project. I don't know where to start and I would need some assistance working through my issues to document them while also maintaining backwards compatibility in the docs for versions of Django I've never worked in.

satcomjimmy avatar May 16 '24 01:05 satcomjimmy

I can't speak for @bennylope but I have contributed to this package a little... Documentation fixes always welcome in general! Good catch on this one, though it can probably be simplified a little: https://github.com/bennylope/django-organizations/pull/275

mgrdcm avatar May 18 '24 18:05 mgrdcm

Thank you, I'm not 100% on the color coding but I believe I've got the PR updated to your spec

satcomjimmy avatar May 19 '24 18:05 satcomjimmy

@satcomjimmy these "little" fixes are a great way to get started and more helpful than you might realize. Thank you!

If you have other updates you'd like to add to the documentation, they'd be welcome. And if you're not sure where to start, or if you want to do that, one very helpful thing is providing specific observations about where and how the docs were confusing. Sometimes familiarity with a project makes it more difficult to see the rough edges.

@mgrdcm sincerely appreciate seeing you jump into the comments and offer guidance.

bennylope avatar May 21 '24 15:05 bennylope

@mgrdcm sincerely appreciate seeing you jump into the comments and offer guidance.

You're welcome! And thanks for this package!

I'm doing some heavy development on a project using django-organizations this week so you might see a couple PRs from me :)

mgrdcm avatar May 21 '24 15:05 mgrdcm