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: contributors guide too vague #813

Open
hkershaw-brown opened this issue Jan 27, 2025 · 0 comments
Open

Documentation: contributors guide too vague #813

hkershaw-brown opened this issue Jan 27, 2025 · 0 comments
Assignees

Comments

@hkershaw-brown
Copy link
Member

What's the issue?

📚 Please describe the problem you’ve noticed in the documentation.

The contributors guide is quite vague about how to contribute to dart.
And it is not super friendly, e.g. find a documentation problem, contribute a fix!

Where did you find the issue?

Provide the location(s) of the issue:

What needs to be fixed?

Share what’s incorrect, unclear, missing, or outdated.

Missing Practicalities of git & github:

  • branching of main
  • keeping your branch up to date
  • exact commands to do this
  • what we expect, e.g what to test, what info to provide
  • what we look for in review
  • basic style guide

There is some typos/weird grammar in there also.

I don't think this is true in general without funding: "DAReS staff can collaborate with you on your private repository,"

Suggestions for improvement

If you have any ideas to fix or generally improve this documentation, please share them.
Make more welcoming,
Clear steps for contributing

Anything else we should know?

Include any other relevant details, such as references, screenshots, or related discussions.
Metpy's contributing guide is quite nice:
https://unidata.github.io/MetPy/latest/devel/CONTRIBUTING.html

@hkershaw-brown hkershaw-brown changed the title Documentation: contributors guide to Documentation: contributors guide too vague Jan 27, 2025
@hkershaw-brown hkershaw-brown self-assigned this Jan 27, 2025
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

1 participant