You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It is often hard to preserve and cover all credits towards ideas and inspirations that shaped projects over time. Often code traces remain, and human involvement fades away.
I often try to mention people who were involved in conversations and inspired ideas (many, are simple bug reports and questions leading to great ideas!) also sometimes in readme this info is not listed in a proper place nor focuses on the human part of the story.
In addition to listing maintainers and their contacts, I am looking to find automation to maintain all involvements. How verbose? As verbose as possible! How frequently updated? As often as possible! Something like CHANGELOG.md but list people's involvements over time, both code contributions and ideas/even important issues/discussions involvement (might be a feature in changelogen perhaps + manual edits?)
HUMANS.md
## Story
(the story behind the project and humans involved)
## Maintainers### [name][contact info]## Inspirations### [project][what was inspired]## Credits## [year] / [month]-[who] - [ref] - [description]-[who] - [ref] - [description]
[who]: (required) A comma-separated list of people, or project/teams to attribute for
[ref]: (optional) Reference to issue/discussion/tweet/pr, etc
[description]: (optional) summary of involvement. (is it a good idea though?!)
The HUMANS.md file is a document commonly included in open-source projects to acknowledge the people behind the project. Unlike README.md, which focuses on technical details, HUMANS.md is more personal and human-centered. It typically lists contributors, maintainers, and other people involved, often with links to their profiles or fun facts.
Its purpose is to celebrate the community and emphasize that real people are behind the code. It can also provide contact information or project philosophies.
(summary by ChatGPT)
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
It is often hard to preserve and cover all credits towards ideas and inspirations that shaped projects over time. Often code traces remain, and human involvement fades away.
I often try to mention people who were involved in conversations and inspired ideas (many, are simple bug reports and questions leading to great ideas!) also sometimes in readme this info is not listed in a proper place nor focuses on the human part of the story.
In addition to listing maintainers and their contacts, I am looking to find automation to maintain all involvements. How verbose? As verbose as possible! How frequently updated? As often as possible! Something like
CHANGELOG.md
but list people's involvements over time, both code contributions and ideas/even important issues/discussions involvement (might be a feature in changelogen perhaps + manual edits?)HUMANS.md
[who]
: (required) A comma-separated list of people, or project/teams to attribute for[ref]
: (optional) Reference to issue/discussion/tweet/pr, etc[description]
: (optional) summary of involvement. (is it a good idea though?!)Inspired by https://github.com/sebiboga/humans-txt
First time i saw this in jdiaz5513/capnp-ts/HUMANS.md by @jdiaz5513 (also fun comments among code was so cool idea!)
Beta Was this translation helpful? Give feedback.
All reactions