Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use CONTRIBUTORS.md instead of README.md #8

Closed
chrissimpkins opened this issue Feb 29, 2016 · 2 comments
Closed

Use CONTRIBUTORS.md instead of README.md #8

chrissimpkins opened this issue Feb 29, 2016 · 2 comments

Comments

@chrissimpkins
Copy link
Collaborator

People are giving of themselves and their free time to contribute to open source projects in so many ways. It can be a real time sink sometimes and so they should be praised for all their contributions (code or not).

+1 I completely agree.

For projects with a small number of contributors, this will work well under a Contributors heading on a README page. For larger, very active projects where hundreds (or more) individuals might meet these criteria, this list will be far too large to include on a project README.md file. I'd recommend that you consider spec'ing a separate CONTRIBUTORS.md page dedicated to these acknowledgments and a link to this page from the project README file.
@kentcdodds
Copy link
Collaborator

Agreed. Angular or React for example have a TON of contributors in various forms. I'm not even sure this is feasible for a project of that popularity. But I want it to be possible. Do you want to add a disclaimer like this to the spec? Make sure to add yourself to the list of contributors per the spec ;-)

@chrissimpkins
Copy link
Collaborator Author

I have some additional thoughts alternating the maintainer and contributor hats (in #9) that expand on this suggestion. Will close this IR and look forward to your thoughts there.

jakebolam added a commit that referenced this issue Feb 4, 2019
@jakebolam
docs: document bot and cli tools (#8)
00bc4ef 
* docs: update all-contributors link

* docs: wip

* docs: tweaks

* new homepage

* docs: wip

* docs: first pass

* docs: tweaks
jakebolam added a commit that referenced this issue Feb 4, 2019
@jakebolam
docs: add website (#153)
f8520b4 
* Initial commit

* Update README.md

* first commit

* docs: add ci badge

* docs: add license

* infra: use nvm locally

* ci: correct deploy key

* docs: all contributors

* docs: badge space

* ci: fix cache key

* docs: contributing

* ci: fix working dir

* ci: website build path

* docs: arrange badges

* docs: all contributors specification

* docs: badge not flat square

* docs: switch to all-contributors org (#1)

* docs: update all-contributors link

* docs: switch org

* docs: chat on slack

* docs: use google analytics

* feat: add branding (#3)

* docs: update all-contributors link

* feat: add branding

* docs: add tbenning as a contributor (#4)

* docs: update README.md

* docs: update .all-contributorsrc

* docs: say hello to @all-contributors bot

* docs: links & grammar

* docs: sync with master repo (drops atom plugin recommendation)

* docs: add Greenkeeper badge 🌴 (#5)

* docs(readme): add Greenkeeper badge

* Update README.md

* docs(overview): added new maintenance category (#6)

This goes hand in hand with
[all-contributors-cli#142](all-contributors/cli#142).

* docs: document bot and cli tools (#8)

* docs: update all-contributors link

* docs: wip

* docs: tweaks

* new homepage

* docs: wip

* docs: first pass

* docs: tweaks

* docs: fix some grammar (#13)

* docs: grammar tweaks

* docs: use github star button

* docs: the problem section for CLI

* docs: cli docs

* docs: wording on motivation

* docs: description wrong

* docs: enable search

* docs: update contributing with search

* chore: added commitizen (#9)

* chore(package): added commitizen

* docs(readme): added the cz badge

* chore(yarn): updated yarn.lock

* chore: removed all-contributors-cli

* feat: add translations (#14)

* translation: first pass

* translation: first pass

* brew

* docs: add translations

* infra: write translations in ci

* infra: drop ci for branches

* valid

* docs: add Jongjineee as a contributor (#18)

* docs: update README.md

* docs: update .all-contributorsrc

* docs: add robertlluberes as a contributor (#19)

* docs: update README.md

* docs: update .all-contributorsrc

* docs(emoji-key): added missing `business` and `content` (#20)

* docs(emoji-key): added missing `business` and `content`

I added the missing types and removed the uneeded `npx` call in the `commit` NPM script.

* docs(emoji-key): removed 'N/I' line

* docs: switch to Portuguese, Brazilian

* docs: switch to Portuguese, Brazilian

* docs: enable chinese simplified zh-CN

* docs: enable chinese simplified zh-CN

* docs: add Berkmann18 as a contributor (#21)

* docs: update README.md

* docs: update .all-contributorsrc

* docs: update README.md

* docs: update .all-contributorsrc

* docs: add MarsXue as a contributor (#22)

* docs: update README.md

* docs: update .all-contributorsrc

* docs: update README.md

* docs: update .all-contributorsrc

* docs: add MatheusRC as a contributor (#25)

* docs: update README.md

* docs: update .all-contributorsrc

* Revert "docs: add MatheusRC as a contributor (#25)" (#26)

This reverts commit b20eae0.

* docs: add MatheusRV as a contributor (#27)

* docs: update README.md

* docs: update .all-contributorsrc

* docs: update README.md

* docs: update .all-contributorsrc

* doc: doc fix (#24)

* docs(emoji-key): added missing `business` and `content`

I added the missing types and removed the uneeded `npx` call in the `commit` NPM script.

* docs: improvements and fixes

Made some bits more comprehensible and fixed some typos

* infra: fix ci

* feat: support translations, drop example files

* docs(cli-usage): use inline code to specify the command "generate" (#28)

* docs: add MarsXue as a contributor (#29)

* docs: update README.md

* docs: update .all-contributorsrc

* docs: add Berkmann18 as a contributor (#31)

* docs: update README.md

* docs: update .all-contributorsrc

* docs: add greenkeeper as a contributor (#32)

* docs: update README.md

* docs: update .all-contributorsrc

* docs: add allcontributors as a contributor (#33)

* docs: update README.md

* docs: update .all-contributorsrc

* docs: add root pages for languages

* docs: remove greenkeeper (#36)

* docs: add Greenkeeper[bot] as a contributor (#37)

* docs: update README.md

* docs: update .all-contributorsrc

* feat: new homepage (#15)

* Added HTML structure for the Index page.

* added base styles, css variables, and a grid. Modified some of the HTML.

* changed a few css rules

* added normalize, continued styling

* added image files, continued styling, modified some of the copy for how to

* fixed the wavey background css

* started adding media queries fixing styling issues

* More css tweaks and adjustments

* couple more styling tweaks, making it responsive

* fixed some flexbox issues. made it more responsive

* feat: add github badge button

* styled the added the github stars widget to live in the nav and float in mobile

* added the icons and styled them for the quick links

* added logos and some styling, might need a last pass on the styles

* changed some copy on buttons, made links open in new tab

* fixing last responsive details on user logos

* wip

* feat: missing files + open graph data

* fix: switch styles over to main.css

* fix: site name

* fixed the issues that the docs css was creating, should be good to go on mobile responsiveness (#43)

docs :fixing CSS

* feat: add 404 page (#44)

* fixed the issues that the docs css was creating, should be good to go on mobile responsiveness

* created a 404 page

* added in / for 404 page

* docs: fix link in 404 page (#45)

* docs: add maryampaz as a contributor (#46)

* docs: update README.md

* docs: update .all-contributorsrc

* feat: add analytics tracking to root pages, and 404s (#47)

* docs: hawaii banner for conference (#50)

* feat: link to jsconfhi

* infra: add 404 check for CI (#52)

* infra: add 404 check for CI

* ci

* background

* sleep less

* check 404s only after release

* infra: smart sleep

* infra: smart sleep

* formik 404

* docs: locallized badge

* docs: switch badge around

* docs: link to build workflow

* docs: few fixes and tweaks (#54)

* aloha, remove use of h1

* docs: move over docs, style footer

* docs: typo fixes (#53)

* docs(emoji-key): added missing `business` and `content`

I added the missing types and removed the uneeded `npx` call in the `commit` NPM script.

* docs: improvements and fixes

Made some bits more comprehensible and fixed some typos

* docs(repository-maintainers): fixed minor typo

* docs(bot): fixed a typo

Fixed the typo in the _overview_ page to the _usage_ one

* docs: fix readme

* website uses allcontributrs.org

* build

* lock file and checkout
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kentcdodds @chrissimpkins