Skip to content

Adds README document#4

Open
hobbs-Hobbler wants to merge 1 commit intoHubs-Foundation:mainfrom
hobbs-Hobbler:add-readme
Open

Adds README document#4
hobbs-Hobbler wants to merge 1 commit intoHubs-Foundation:mainfrom
hobbs-Hobbler:add-readme

Conversation

@hobbs-Hobbler
Copy link

@hobbs-Hobbler hobbs-Hobbler commented Jan 12, 2026

What?

Adds README document for the .github repository. Includes why HF uses GitHub. 3 general expectations. How to contribute and that HF is responsible.

Why?

Repository did not have an initial README

Limitations

None

Alternatives considered

Could keep swimming with no README but then this repository would look pointless.

Open questions

  1. I could not remember our official name for our Principles and Values (and would possibly like to add a link to those if they are link-able).
  2. Fact check the number of repositories.
  3. Should I add any reference to the responsibility of the Communication & Documentation Team within HF, rather than just HF, or is that making this repository seem a tad more unnecessarily exclusive?

Additional details or related context

Forgive commit typos.
Comments welcome.

Used this reference from GitHub Followed this guidance:

A README is often the first item a visitor will see when visiting your repository. README files typically include information on:

  • What the project does
  • Why the project is useful
  • How users can get started with the project
  • Where users can get help with your project
  • Who maintains and contributes to the project

What: Adds README document for the .github repository.
Includes why HF uses Github. 3 general expecations.
How to contribute and that HF is resposible.

Why: Repository did not have an initial README>

Note: I could not remember our official name for our
Principles and Values (and would possibly like to add
a link to those if they are linkable). Fact check the number
of repositories. :) Comments welcome.
@hobbs-Hobbler
Copy link
Author

Note follow-up from discussion at January 14, 2026 Documentation Session. This README, via the magic of GitHub, would automatically become the main README of (gulp) the entire Hubs Foundation GitHub account. THAT WAS NOT INTENDED.

More research will be done on where and in what form this PR will need to take that is more appropriate to it's purpose: to share issues and PRs across all repositories, to provide global templates and to discuss cross-team issues.

For the moment, this PR is in a holding pattern.

@Exairnous
Copy link
Member

Note follow-up from discussion at January 21, 2026 Documentation Session. I was mistaken when I said at the January 14 meeting that this README would become the main README of the entire Hubs Foundation GitHub account. Unlike the special repository for user accounts, this README will only be the README for this repository, the README for the entire Hubs Foundation GitHub account would be placed in a .profile folder within this repository. https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile

This PR is still in a holding pattern until the sprints are done, but afterwards can proceed as usual.

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

Successfully merging this pull request may close these issues.

2 participants

Comments