llvm / llvm/Community.o

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

Open
#13 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
1
Forks
1
PR merge metrics
No merged PRs in 30d

Description

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?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by reviewing the existing Community.o resources and newcomer guidance to find where this proposal belongs. Done would be a clear, actionable explanation of how newcomers can request or contribute documentation despite social anxiety.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.