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

[gautamarora]

[taveras]

@gautamarora @johnkpaul @pgoldrbx how do we feel about the Clear Github History item in the checklist?

we can remove / flatten a few those merge commits if we'd like, but is there any other feedback for what should be changed?

[gautamarora]

@taveras - I think that is more relevant from the POV of not having commits that show sensitive data (before open sourcing) in the repo, but this project has been clean from the get go, so not an issue for it.

[johnkpaul]

The reason why that was asked for by the lawyers was because it helped mitigate any worry around accidentally revealing anything we didn't want to reveal when considering moving something from internal and private to public and open source.

In this particular case, it was written as standalone from the beginning and I don't have concerns the git history could cause problems.

[taveras]

👌 this makes sense, and understood! checking off that item on the list