xml-to-react icon indicating copy to clipboard operation
xml-to-react copied to clipboard

Published 20 hours ago • verified publisher icon CondeNast

Complete Open Source Checklist

Open gautamarora opened this issue 7 years ago • 9 comments

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

Documentation

  • [x] README
  • [x] CONTRIBUTING (#24)
  • [x] CODE_OF_CONDUCT
  • [x] LICENSE
  • [x] ISSUE_TEMPLATE
  • [x] PULL_REQUEST_TEMPLATE
  • [x] CHANGELOG (#25)
  • [ ] Announcement Blog Post

Development

  • [x] Tests
  • [x] Linter
  • [x] Travis
  • [ ] Examples
  • [x] Clear Github History

README Checklist

  • [x] Title
  • [ ] Badges
  • [x] Description
  • [x] Prerequisite for using software ( if any ) (https://github.com/CondeNast/xml-to-react/pull/33)
  • [x] Install
  • [x] Example Usage
  • [ ] Screenshots and GIFs
  • [x] Contributors (https://github.com/CondeNast/xml-to-react/pull/36)
  • [x] Conde Nast Technology Logo (https://github.com/CondeNast/xml-to-react/pull/31)
  • [x] Attributions ( mention 3rd party libs used etc. ) (https://github.com/CondeNast/xml-to-react/pull/32)
  • [ ] Benchmarks (if any)
  • [x] Prior Art (if any) (https://github.com/CondeNast/xml-to-react/pull/35)

Badges Checklist:

  • [x] License Badge
  • [ ] Testing Badge
  • [x] CI Badge

gautamarora avatar Dec 20 '17 16:12 gautamarora

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

pgoldrbx avatar Dec 21 '17 21:12 pgoldrbx

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

taveras avatar Jan 05 '18 17:01 taveras

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

gautamarora avatar Jan 05 '18 17:01 gautamarora

@taveras logos for cn tech have been added here

gautamarora avatar Jan 09 '18 15:01 gautamarora

image

gautamarora avatar Jan 17 '18 22:01 gautamarora

@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?

taveras avatar Jan 18 '18 05:01 taveras

@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.

gautamarora avatar Jan 18 '18 16:01 gautamarora

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.

johnkpaul avatar Jan 18 '18 17:01 johnkpaul

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

taveras avatar Jan 18 '18 19:01 taveras