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.

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

New contributor guidelines; Add AUTHORS.md #660

Merged
merged 4 commits into from Mar 8, 2016
Merged
Changes from all commits
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

This file was deleted.

@@ -0,0 +1,65 @@
# Authors

#### Ordered by first contribution.

- Feross Aboukhadijeh <feross@feross.org>
- John Hiesey <jhiesey@cs.stanford.edu>
- Brad Berger <brad@bradb.net>
- Matt Buresh <mattburesh@gmail.com>
- cagedwisdom <cagedwisdom@tricorder.org>
- Charles Julian Knight <charles@rabidaudio.com>
- Maurits van Mastrigt <maurits@nerdieworks.nl>
- Shyam S Kumar <shyam.salim.kumar@outlook.com>
- fisch0920 <fisch0920@gmail.com>
- iShift <shift.rus@gmail.com>
- Bob Ren <bob@codecademy.com>
- gtuk <gtuk@hush.ai>
- thammin <thammin@live.co.uk>
- Valérian Galliat <val@codejam.info>
- opfl <openthefrog@gmail.com>
- Chris <abody.97@gmail.com>
- Astro <astro@spaceboyz.net>
- Sindre Sorhus <sindresorhus@gmail.com>
- Josh Duff <me@JoshDuff.com>
- Anthony MOI <anthony@totems.co>
- Joseph Dykstra <josephdykstra@gmail.com>
- mathiasvr <mathiasvr@gmail.com>
- grunjol <grunjol@argenteam.net>
- Liam Curry <liam@curry.name>
- Francisco Pinzon <hello@pacho.me>
- Jake Fulton Buckle <jacobafb@gmail.com>
- alexeisavca <savca.alexei@gmail.com>
- Olivier Lalonde <olalonde@gmail.com>
- Johnny Tong <mailbox@johnnytong.com>
- Mark Vayngrib <mark.vayngrib@lablz.com>
- Tristan Davies <github@tristan.io>
- Eric Wooley <ericwooley@gmail.com>
- Afshin Mehrabani <afshin.meh@gmail.com>
- Josip Janžić <josip.janzic@gmail.com>
- Bigard Florian <florian.bigard@gmail.com>
- OlaviSau <olavisau@gmail.com>
- Simba Zhang <solderzzc@gmail.com>
- Gilles De Mey <gilles.de.mey@gmail.com>
- Linus Unnebäck <linus@folkdatorn.se>
- André Stein <stivekx@gmail.com>
- Joseph Frazier <joseph@onsip.com>
- Yousef Amar <yousefamar@gmail.com>
- Lucas Pelegrino <lucas.wxp@gmail.com>
- Yoann Ciabaud <yoann@atacma.agency>
- Joseph Frazier <1212jtraceur@gmail.com>
- Ivan Vučica <ivan@vucica.net>
- ReadmeCritic <frankensteinbot@gmail.com>
- vinz243 <vinz243@gmail.com>
- Diego Rodríguez <diegorbaquero@gmail.com>
- Aram Drevekenin <grimsniffer@gmail.com>
- andreapaiola <andrea.paiola@gmail.com>
- Hrvoje Šimić <me@shime.io>
- Romain Beaumont <romain.rom1@gmail.com>
- Zander Mackie <zander@skilledup.com>
- Wim <wim@sitebase.be>
- William Blankenship <william.jblankenship@gmail.com>
- James Halliday <mail@substack.net>
- Bazyli Brzóska <bazyli.brzoska@gmail.com>

#### Generated by tools/authors.sh.

@@ -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.
@@ -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:
<table><tbody>
<tr><th align="left">Feross Aboukhadijeh</th><td><a href="https://github.com/feross">GitHub/feross</a></td><td><a href="https://twitter.com/feross">Twitter/@feross</a></td></tr>
<tr><th align="left">Daniel Posch</th><td><a href="https://github.com/dcposch">GitHub/dcposch</a></td><td><a href="https://twitter.com/dcposch">Twitter/@dcposch</a></td></tr>
<tr><th align="left">John Hiesey</th><td><a href="https://github.com/jhiesey">GitHub/jhiesey</a></td><td><a href="https://twitter.com/jhiesey">Twitter/@jhiesey</a></td></tr>
<tr><th align="left">Travis Fischer</th><td><a href="https://github.com/fisch0920">GitHub/fisch0920</a></td><td><a href="https://twitter.com/fisch0920">Twitter/@fisch0920</a></td></tr>
<tr><th align="left">Astro</th><td><a href="https://github.com/astro">GitHub/astro</a></td><td><a href="https://twitter.com/astro1138">Twitter/@astro1138</a></td></tr>
<tr><th align="left">Iván Todorovich</th><td><a href="https://github.com/ivantodorovich">GitHub/ivantodorovich</a></td><td><a href="https://twitter.com/ivantodorovich">Twitter/@ivantodorovich</a></td></tr>
<tr><th align="left">Mathias Buus</th><td><a href="https://github.com/mafintosh">GitHub/mafintosh</a></td><td><a href="https://twitter.com/mafintosh">Twitter/@mafintosh</a></td></tr>
<tr><th align="left">Bob Ren</th><td><a href="https://github.com/bobrenjc93">GitHub/bobrenjc93</a></td><td><a href="https://twitter.com/bobrenjc93">Twitter/@bobrenjc93</a></td></tr>
<tr><th align="left">James Halliday</th><td><a href="https://github.com/substack">GitHub/substack</a></td><td><a href="https://twitter.com/substack">Twitter/@substack</a></td></tr>
<tr><th align="left">Gilles De Mey</th><td><a href="https://github.com/gillesdemey">GitHub/gillesdemey</a></td><td><a href="https://twitter.com/gdemey">Twitter/@gdemey</a></td></tr>
<tr><th align="left">Valérian Galliat</th><td><a href="https://github.com/valeriangalliat">GitHub/valeriangalliat</a></td><td><a href="https://twitter.com/valeriangalliat">Twitter/@valeriangalliat</a></td></tr>
<tr><th align="left">Joseph Frazier</th><td><a href="https://github.com/josephfrazier">GitHub/josephfrazier</a></td><td></td></tr>
<tr><th align="left">Lucas Pelegrino</th><td><a href="https://github.com/lucaswxp">GitHub/lucaswxp</a></td><td><a href="https://twitter.com/lucaswxp">Twitter/@lucaswxp</a></td></tr>
<tr><th align="left">Diego Rodríguez B.</th><td><a href="https://github.com/DiegoRBaquero">GitHub/DiegoRBaquero</a></td><td><a href="https://twitter.com/DiegoRBaquero">Twitter/@DiegoRBaquero</a></td></tr>
</tbody></table>
#### Enable debug logs
In **node**, enable debug logs by setting the `DEBUG` environment variable to the name of the
@@ -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 /<support\@greenkeeper.io>/;
next if /<badger\@gitter.im>/;
next if /<y.ciabaud\@free.fr>/;
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
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.