Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

Renamed about*.md -> readme.md to display by default on GitHub. #113

Closed
wants to merge 1 commit into from
Closed

Conversation

rimutaka
Copy link

I'm not sure what the rationale was for naming files as about_xxx.md, but if I go into a folder on GitHub I have only a list of files and then have to choose what to click on. I think it makes sense to follow GitHub ways and name all about_xxxx.md files readme.md to display the "about" content by default.

@jaredmorgs
Copy link
Contributor

Was there an issue open for this change? Generally we discuss a change like this in an issue first before diving in.

I think I named these with the about-* prefix because they were designed to be read after checking out the main repo as meta-docs.

Think of them like pages in a static site more than a traditional README.

@mgan59
Copy link
Contributor

mgan59 commented May 27, 2020

@rimutaka

  1. We prefer that an issue is first opened and discussed. Once the issue has been discussed and the scope of work outlined. Then a pull-request with the proposed changes can be opened -- citing the initial issue.

  2. And to build on Jared's point, README are typically meant as a document-type that sits in a root of a git-repository. Though they can be leveraged internally with the github ui to render documentation at the folder level, this is comes at the expense of obscuring the true contents of the markdown file. As a best practice documents should have a file-name that describes the content and nature of the document. Also makes it possible to move documents from one folder to another more easily without having to worry about conflicting file-names of readme.md

We are closing this PR, but thank you for your contribution. We encourage you to join us in the issues panel for future collaboration.

@mgan59 mgan59 closed this May 30, 2020
@mgan59 mgan59 added the wontfix This will not be worked on label May 30, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
wontfix This will not be worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants