Skip to content

GitHub Profile README

This document covers some of the author's considerations for the README of the author's GitHub profile.

The following are sections that the author has considered having in their profile README.

  • Packages I Am Building: Details current software that the author is building for others to use.
  • Replications Of Research Papers: Details works of research that the author has fully or partially replicated.
  • Repositories I Contribute To For Work: Details repositories that the author has been paid to work on (as part of a career).
  • Lists: A list of lists that the author has created for personal use and that the author believes might be useful for others to see.
  • Data Visualizations: Details data visualizations created by the author to learn about some phenomenon or for entertainment.
  • How I Can Help Others: Descriptions of what the author might be able to help others with, if they were to ask.
  • How Others Can Help Me: Descriptions of what the author desires to receive help with from others.
  • My Standards & Behavioral Algorithms: The author's standards and rules of operations when it comes to some aspects of programming and or related work.
  • Cool Repositories I've Contributed To: External, non-work repositories that the author has contributed to and wants to share with others.
  • Equations To Remember: Mathematical equations that the author has encountered and finds interesting enough to share with others publicly.
  • Sayings, Quotes, And Things To Ponder: A collection of thought-provoking quotes that the author has encountered in reading, mantras that the author has generated, and principles that the author has found some utility.
  • Books I've Read And My Reviews: Details books that the author has read and reviewed.
  • Wishes For The Future: Details what the author wishes for humanity to accomplish and for how humanity could exist in the universe.
  • Things I Do Not Like: Details elements across a variety of domains that the author generally does not prefer and or of which the author wishes there was less.
  • Things I Like: Details elements across a variety of domains that the author generally does prefer and or of which the author wishes there was more.
  • Statements: Details the author's perspectives, takes, and or stances on certain topics, especially within ethics and technology.
  • Accomplishments: Details actions that the author has taken for which the author is proud.
  • Models Built: Details models that the author has built across his work.
  • 20XX Predictions: The author's predictions for the year 20XX.
  • Figures I Respect: Details people that the author wishes to emulate in some capacity.
  • Preferences: Details what the author prefers and or how the author tends to operate.

Other considerations:

  • How much information to have publicly available?
  • ...on GitHub?
  • ...on a personal website?
  • ...on forums and other sites?
  • Is having where the author works too much information? Given that the author is not able to make this information (the organization) disappear from his profile, the author feels inclined to "lay low".
  • What goals are there with having a personal README?
  • Permit others to understand my values.
  • Permit others to understand and make informed predictions about my behavior.
  • Permit others to make an informed decision about whether they want to communicate with me.
  • Permit others to make an informed judgement about my person.
  • How much information is too burdensome to readers?
  • Dropdown menus can greatly help with permitting more information.
  • Some elements in the Sections list might better be situated on a personal website.
  • Perhaps a threshold of 5 sections total or per dropdown is a reasonable bottleneck.
  • Leaving the README blank is an option.
  • Leaving the biography blank is an option.