microsoft / microsoft/react-native-windows-samples

Contribution guide is lacking in repo-specific content

Open
#95 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Engineering Improvement Candidate enhancement
Dominant language
C#
Stars
544
Forks
218
PR merge metrics
No merged PRs in 30d

Description

We do include some contribution information on the website here.

I don't think it's terribly helpful as is.

There's an issue capturing some complaints on the main repo, but if we have docs on the website we should probably track that portion here. Also that issue is too broad, and we should break down specific items.

I'm starting here by capturing feedback with checkboxes. These could be cards on a project board if we'd like to do it that way. Or individual issues. But for now... just need to capture the feedback.

When looking at contribution guides, here are some references:

Of note, this doc isn’t great. It’s more “here’s how to use git”, not “here are the quirks to contributing to this repo”.

  • Remove SourceTree recommendation (it doesn't seem to be used by most of our core maintainers)
  • Replace the boiler plat "how to use git" content with links to existing resources/articles.
    • Feedback: "this was mostly useful because it mentioned ‘yarn change’ and linked to the branch setup page"

There’s also this page on the wiki that’s at least more specifically helpful: https://github.com/microsoft/react-native-windows/wiki/Setup

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

Start by reviewing docs/contributing.md, the website contribution page and sidebar, and packages/playground/README.md, then compare them with the linked React Native and WinUI contribution references. Done should mean the selected contribution-guide content is repo-specific, duplicates are resolved, the building article is discoverable, and the Playground README links are corrected; the RNTester documentation remains tied to its proposed changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
react-native
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.