diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index 3ac2c69d..00000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,35 +0,0 @@ -# WebTorrent Contributing Guidelines - -- Always use WebTorrent for legal downloads. -- Always search for a related issue before starting a new issue. -- Always choose a concise, helpful issue name. -- Always stay on-topic. If you've got a new bug report or feature request, put it in its own issue. -- Always be polite to other people. -- Never post private information, such as torrent or tracker names, IP addresses, etc. - -Issues that break the rules may be deleted and locked without warning. - -## WebTorrent is an OPEN Open Source Project - -Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project. - -## Rules - -There are a few basic ground-rules for contributors: - -1. **No `--force` pushes** or modifying the Git history in any way. -1. **External API changes and significant modifications** should be subject to a **pull request** to solicit feedback from other contributors. -1. Pull requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor. -1. Use a non-`master` branch for ongoing work. -1. Contributors should attempt to adhere to the prevailing code style. -1. Run `npm test` locally before submitting your PR to catch easy-to-miss style & testing issues - -## Releases - -Declaring formal releases remains the prerogative of the project maintainer. - -## Changes to this arrangement - -This is an experiment and feedback is welcome! This document is subject to pull requests or changes by contributors where you believe you have something valuable to add or change. - -*Thanks to [Rod Vagg](https://github.com/rvagg) and the [LevelUP](https://github.com/rvagg/node-levelup) project for coming up with this model of open source contribution.* diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 00000000..5616fac1 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,65 @@ +# Authors + +#### Ordered by first contribution. + +- Feross Aboukhadijeh +- John Hiesey +- Brad Berger +- Matt Buresh +- cagedwisdom +- Charles Julian Knight +- Maurits van Mastrigt +- Shyam S Kumar +- fisch0920 +- iShift +- Bob Ren +- gtuk +- thammin +- Valérian Galliat +- opfl +- Chris +- Astro +- Sindre Sorhus +- Josh Duff +- Anthony MOI +- Joseph Dykstra +- mathiasvr +- grunjol +- Liam Curry +- Francisco Pinzon +- Jake Fulton Buckle +- alexeisavca +- Olivier Lalonde +- Johnny Tong +- Mark Vayngrib +- Tristan Davies +- Eric Wooley +- Afshin Mehrabani +- Josip Janžić +- Bigard Florian +- OlaviSau +- Simba Zhang +- Gilles De Mey +- Linus Unnebäck +- André Stein +- Joseph Frazier +- Yousef Amar +- Lucas Pelegrino +- Yoann Ciabaud +- Joseph Frazier <1212jtraceur@gmail.com> +- Ivan Vučica +- ReadmeCritic +- vinz243 +- Diego Rodríguez +- Aram Drevekenin +- andreapaiola +- Hrvoje Šimić +- Romain Beaumont +- Zander Mackie +- Wim +- William Blankenship +- James Halliday +- Bazyli Brzóska + +#### Generated by tools/authors.sh. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..6eeafcb8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,47 @@ +# Contributing Guidelines + +Contributions welcome! + +**Before spending lots of time on something, ask for feedback on your idea first!** + +Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations. + +This project welcomes non-code contributions, too! The following types of contributions are welcome: + +- **Ideas**: participate in an issue thread or start your own to have your voice heard. +- **Writing**: contribute your expertise in an area by helping expand the included content. +- **Copy editing**: fix typos, clarify language, and generally improve the quality of the content. +- **Formatting**: help keep content easy to read with consistent formatting. + +## Code Style + +[![standard][standard-image]][standard-url] + +This repository uses [`standard`][standard-url] to maintain code style and consistency, and to avoid style arguments. `npm test` runs `standard` automatically, so you don't have to! + +[standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg +[standard-url]: https://github.com/feross/standard + +# Project Governance + +**This is an [OPEN Open Source Project](http://openopensource.org/).** + +Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project. + +## Rules + +There are a few basic ground-rules for contributors: + +1. **No `--force` pushes** or modifying the Git history in any way. +1. **Non-master branches** ought to be used for ongoing work. +1. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors. +1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor. +1. Contributors should attempt to adhere to the prevailing code style. + +## Releases + +Declaring formal releases remains the prerogative of the project maintainer. + +## Changes to this arrangement + +This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change. diff --git a/README.md b/README.md index 286bec41..edc7f786 100644 --- a/README.md +++ b/README.md @@ -742,29 +742,6 @@ These are the main modules that make up WebTorrent: [ut_pex-ni]: https://img.shields.io/npm/v/ut_pex.svg [ut_pex-nu]: https://www.npmjs.com/package/ut_pex -### Contribute - -WebTorrent is an **[OPEN Open Source Project](https://github.com/feross/webtorrent/blob/master/CONTRIBUTING.md)**. Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. - -WebTorrent is only possible due to the excellent work of the following contributors: - - - - - - - - - - - - - - - - -
Feross AboukhadijehGitHub/ferossTwitter/@feross
Daniel PoschGitHub/dcposchTwitter/@dcposch
John HieseyGitHub/jhieseyTwitter/@jhiesey
Travis FischerGitHub/fisch0920Twitter/@fisch0920
AstroGitHub/astroTwitter/@astro1138
Iván TodorovichGitHub/ivantodorovichTwitter/@ivantodorovich
Mathias BuusGitHub/mafintoshTwitter/@mafintosh
Bob RenGitHub/bobrenjc93Twitter/@bobrenjc93
James HallidayGitHub/substackTwitter/@substack
Gilles De MeyGitHub/gillesdemeyTwitter/@gdemey
Valérian GalliatGitHub/valeriangalliatTwitter/@valeriangalliat
Joseph FrazierGitHub/josephfrazier
Lucas PelegrinoGitHub/lucaswxpTwitter/@lucaswxp
Diego Rodríguez B.GitHub/DiegoRBaqueroTwitter/@DiegoRBaquero
- #### Enable debug logs In **node**, enable debug logs by setting the `DEBUG` environment variable to the name of the diff --git a/bin/update-authors.sh b/bin/update-authors.sh new file mode 100755 index 00000000..2b7fd79b --- /dev/null +++ b/bin/update-authors.sh @@ -0,0 +1,22 @@ +#!/bin/sh +# Update AUTHORS.md based on git history. + +git log --reverse --format='%aN <%aE>' | perl -we ' +BEGIN { + %seen = (), @authors = (); +} +while (<>) { + next if $seen{$_}; + next if //; + next if //; + next if //; + next if /<.*\@users.noreply.github.com>/; + $seen{$_} = push @authors, "- ", $_; +} +END { + print "# Authors\n\n"; + print "#### Ordered by first contribution.\n\n"; + print @authors, "\n"; + print "#### Generated by tools/authors.sh.\n\n"; +} +' > AUTHORS.md