better contribution guidelines

This commit is contained in:
François 2016-04-24 12:30:49 +02:00
parent 62919666e4
commit 10c839a577

View File

@ -4,25 +4,9 @@ The primary aim of the [Awesome Network Analysis list](https://github.com/briatt
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
## Copyright Waiver
- __All resources__ are listed alphabetically.
- __All titles__ are Title Cased, Chicago-style.
- __Authors__ are required for blog series, selected papers, books and courses.
- __Dates__ are mentioned for books and tutorials.
- __Default spelling__ is __U.S. English__.
- __Do not use__
- __copyright or trademark symbols__.
- __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.
If you contribute to this list, 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).
## Inclusion Criteria
@ -40,6 +24,36 @@ The [Awesome Manifesto](https://github.com/sindresorhus/awesome/blob/master/awes
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
## Publishing Roadmap
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).
- [v1.0](https://github.com/briatte/awesome-network-analysis/releases/tag/v1.0) - First draft (April 12, 2016).
- [v1.1](https://github.com/briatte/awesome-network-analysis/milestones/v1.1) - Moar awesomeness (April 30, 2016).
- [v1.2](https://github.com/briatte/awesome-network-analysis/milestones/v1.2) - Trim down and comment on selected resources (May 15, 2016).
- [v1.3](https://github.com/briatte/awesome-network-analysis/milestones/v1.3) - Finalize with invited collaborators (May 30, 2016).
- [v1.4](https://github.com/briatte/awesome-network-analysis/milestones/v1.4) - Publish short companion note with collaborators (June 15, 2016).
Details on how collaborators were recruited appear in the [publishing roadmap](https://github.com/briatte/awesome-network-analysis/wiki/publishing-roadmap).
## Style Guide
- __All resources__ are listed alphabetically.
- __All titles__ are Title Cased, Chicago-style.
- __Authors__ are required only for blog series, selected papers, books and courses.
- __Books__ should link to their official publisher's page, not a vendor's page.
- __Dates__ are mentioned for books and tutorials.
- __Default spelling__ is __U.S. English__.
- __Do not use__
- __copyright or trademark symbols__.
- __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 include only journals with __~ 75% or more content__ about network analysis.
- Please mention if the journal is __gated__ or not.
- __Language__ is required if the resource is not in English.
- Additions in __all languages__ are welcome.
- Consider __translating titles__ into 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.