mirror of
https://github.com/briatte/awesome-network-analysis.git
synced 2024-10-01 01:06:13 -04:00
moving contributions guidelines out
This commit is contained in:
parent
28091c31a4
commit
756a3493ba
44
CONTRIBUTING.md
Normal file
44
CONTRIBUTING.md
Normal file
@ -0,0 +1,44 @@
|
||||
# Contribution Guidelines
|
||||
|
||||
The primary aim of the [Awesome Network Analysis list](https://github.com/briatte/awesome-network-analysis) is to spread awesome network analysis resources.
|
||||
|
||||
Please contribute to it by sending [pull requests](https://github.com/briatte/awesome-network-analysis/pulls) or by fixing its [issues](https://github.com/briatte/awesome-network-analysis/issues).
|
||||
|
||||
## Style Guide
|
||||
|
||||
- __All resources__ are listed alphabetically.
|
||||
- __All titles__ are Title Cased, Chicago-style.
|
||||
- __Authors__ are required for blog series, books and courses.
|
||||
- __Dates__ are mentioned for books and tutorials.
|
||||
- __Default spelling__ is __U.S. English__.
|
||||
- __Do not use__
|
||||
- __quotes__ around titles
|
||||
- __monospace text__ for software names
|
||||
- __Italics__ are used only for books and journal names.
|
||||
- __Journals__ require the name of the publisher.
|
||||
- Please mention if the journal is __gated__ or not.
|
||||
- __Language__ is required if the resource is not in English.
|
||||
- __Review Articles__ require a journal and date indication.
|
||||
- __Software__ should be at least free for noncommercial use (only [few exceptions](https://github.com/briatte/awesome-network-analysis/wiki/rejected-content#systematic-rejections) will be granted).
|
||||
- __R__: consider citing the stable __CRAN__ version when it exists.
|
||||
- __Python__: consider citing the __PyPi__ version when it exists.
|
||||
|
||||
## Inclusion Criteria
|
||||
|
||||
The [Awesome Manifesto](https://github.com/sindresorhus/awesome/blob/master/awesome.md) states:
|
||||
|
||||
> __Only awesome is awesome__
|
||||
>
|
||||
> Research if the stuff you're including is actually awesome. Put only stuff on the list you or another contributor can personally recommend and rather leave stuff out than include too much.
|
||||
>
|
||||
> ...
|
||||
>
|
||||
> __Comment on why something is awesome__
|
||||
>
|
||||
> Apart from suggesting a particular item on your list, you should also inform your readers why it's on the list and how they will benefit from it.
|
||||
|
||||
See the [list of rejected content](https://github.com/briatte/awesome-network-analysis/wiki/rejected-content) for counter-examples of non-awesome or off-topic stuff _not_ to submit.
|
||||
|
||||
## Copyright Waiver
|
||||
|
||||
Please add your name to the copyright waiver at the end of the list, with an optional link to your personal homepage, GitHub profile, or social media profile (Facebook, LinkedIn, Twitter, whatever).
|
31
README.md
31
README.md
@ -37,7 +37,7 @@ Inspired by [Awesome Deep Learning](https://github.com/ChristosChristofidis/awes
|
||||
- __[Fictional Networks](#fictional-networks)__
|
||||
- __[Network Science](#network-science)__
|
||||
- __[Small Worlds](#small-worlds)__
|
||||
- __[Contribution Guidelines](#contribution-guidelines)__
|
||||
- __[Contribution Guidelines](CONTRIBUTING.md)__
|
||||
- __[License](#license)__
|
||||
|
||||
## Books
|
||||
@ -441,35 +441,6 @@ Inspired by [Awesome Deep Learning](https://github.com/ChristosChristofidis/awes
|
||||
|
||||
* * *
|
||||
|
||||
## Contribution Guidelines
|
||||
|
||||
Please contribute to this list by sending a [pull request](https://github.com/briatte/awesome-network-analysis/pulls).
|
||||
|
||||
- __All resources__ are listed alphabetically, with date and language mentions when relevant.
|
||||
- __Authors__ are required for books and courses only, but are also mentioned for blog series.
|
||||
- __Italics__ are used for books and journal names.
|
||||
- __Journals__ require the name of the publisher.
|
||||
- __Quotes__ are not used.
|
||||
- __Monospace__ is not used.
|
||||
- __Review Articles__ require a journal and a date.
|
||||
- __R packages__: please consider citing the stable __CRAN__ version when it exists.
|
||||
- __Python packages__: please consider citing the __PyPi__ version when it exists.
|
||||
- __Software__ should be at least free for noncommercial use (only few exceptions will be granted).
|
||||
|
||||
Please use U.S. English and remember that an awesome list has to be, well, awesome. The "[Awesome Manifesto](https://github.com/sindresorhus/awesome/blob/master/awesome.md)" states:
|
||||
|
||||
> __Only awesome is awesome__
|
||||
>
|
||||
> Research if the stuff you're including is actually awesome. Put only stuff on the list you or another contributor can personally recommend and rather leave stuff out than include too much.
|
||||
>
|
||||
> ...
|
||||
>
|
||||
> __Comment on why something is awesome__
|
||||
>
|
||||
> Apart from suggesting a particular item on your list, you should also inform your readers why it's on the list and how they will benefit from it.
|
||||
|
||||
Please also add your name to the copyright waiver below, with an optional link to your personal homepage, GitHub profile or social media profile.
|
||||
|
||||
## License
|
||||
|
||||
[![CC0](http://i.creativecommons.org/p/zero/1.0/88x31.png)](http://creativecommons.org/publicdomain/zero/1.0/)
|
||||
|
Loading…
Reference in New Issue
Block a user