Consider creating a .github repository?

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
github
Domain
documentation

Research direction

Start with GitHub's default community health file documentation and the linked Node.js organization profile example. Review the proposed .github/profile/README.md, CODE_OF_CONDUCT.md, SECURITY.md, and CONTRIBUTING.md files, then confirm which organization-wide defaults Bytecode Alliance wants and what the profile should contain. Done means the agreed .github repository structure and profile are established for the organization.

Written by the indexing model from the issue text.

Description

Hello! 👋

Not really sure where to recommend this or whether there's a formal procedure or what. I just wanted to pose the idea that @bytecodealliance should have a .github meta repo https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

Why this would be a good idea:

  • Outline what Bytecode Alliance is right on the https://github.com/bytecodealliance GitHub profile/org page
  • Be able to set an organization-wide CODE_OF_CONDUCT.md file
  • Be able to set an organization-wide SECURITY.md file
  • etc. for other org-wide default files like CONTRIBUTING.md or whatever

Mainly though I would very much like to see a .github/profile/README.md similar to Node.js' profile readme:

image
https://github.com/nodejs

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

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.

More from bytecodealliance/rfcs

All issues in bytecodealliance/rfcs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.