Complete Open Source Checklist

[gautamarora]

This is a master issue to work through the Condé Nast Open Source Checklist.

Documentation

• README
• CONTRIBUTING (Create CONTRIBUTING.md #24)
• CODE_OF_CONDUCT
• LICENSE
• ISSUE_TEMPLATE
• PULL_REQUEST_TEMPLATE
• CHANGELOG (Create CHANGELOG.md #25)
• Announcement Blog Post

Development

• Tests
• Linter
• Travis
• Examples
• Clear Github History

README Checklist

• Title
• Badges
• Description
• Prerequisite for using software ( if any ) (Add prerequisites to README #33)
• Install
• Example Usage
• Screenshots and GIFs
• Contributors (Add Contributors to README #36)
• Conde Nast Technology Logo (Add Conde Nast Tech logo to README #31)
• Attributions ( mention 3rd party libs used etc. ) (Add Attribution to README #32)
• Benchmarks (if any)
• Prior Art (if any) (Add Prior Art to the README #35)

Badges Checklist:

• License Badge
• Testing Badge
• CI Badge

[pgoldrbx]

Templates:
https://github.com/CondeNast/evangelism/tree/master/open-source/templates

[taveras]

@gautamarora do we have a particular asset to use for the Condé Nast Technology logo?

[gautamarora]

yes, i will add it to templates and report back.

[gautamarora]

@taveras logos for cn tech have been added here