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

Documentation Volunteer #274

Open
satcomjimmy opened this issue May 16, 2024 · 4 comments
Open

Documentation Volunteer #274

satcomjimmy opened this issue May 16, 2024 · 4 comments

Comments

@satcomjimmy
Copy link
Contributor

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.

@mgrdcm
Copy link
Contributor

mgrdcm commented May 18, 2024

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: #275

@satcomjimmy
Copy link
Contributor Author

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

@bennylope
Copy link
Owner

@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.

@mgrdcm
Copy link
Contributor

mgrdcm commented May 21, 2024

@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 :)

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

3 participants