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

Encourage newcomers to create PRs with updated documentation when it's missing for them #13

Open
kbeyls opened this issue Apr 15, 2024 · 0 comments

Comments

@kbeyls
Copy link

kbeyls commented Apr 15, 2024

At the EuroLLVM 2024 community.o workshop, many newcomers point out that a lot of areas in LLVM are underdocumented. The backend was highlighted as especially lacking.

One idea we had was that maybe the best way to improve documentation is that when the documentation isn't good enough for what you need to work on; you (as a newcomer) should write up a pull request with documentation describing how you think how it works. Even if it's wrong, that's the best way to get the people with more experience to point you in the right direction. And as a side-effect, the project's documentation improves. This should be documented clearly as a "the most powerful way to get the documentation you need to be created".

Of course, this is at odds with newcomers often feeling "social anxiety" to do anything publicly.

How could we help overcome this?

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