Marketing checklist for NCBI hackathons

NCBI-Hackathons-products-checklist.md

NCBI hackathon product checklist

In order to maintain the online list of products created at NCBI hackathons, each shipped product's repo should include the following:

• Title (required) - the proper display title for the product, with no unnecessary underscores/hyphens/lack of whitespace/etc., e.g., "NCBI Computational Cookbook", not "NCBIComputationalCookbook" or "NCBI_Computational_Cookbook"; achieve this via one of two methods:
  1. the repo name itself, ONLY IF it is the string of the ideal product name for display purposes, or,
  2. an issue titled title, with a label titled metadata, and the body of which should contain only the human readable title string for display purposes; see NCBI-Hackathons/ncbi-hackathons.github.io#5
• Description (required) - the proper display description for the product, with proper grammer/punctuation/capitalization/etc.; achieve this via one of two methods:
  1. the repo description as input on the repo's homepage, above the list of repo files itself, ONLY IF this is the string of the ideal product description for display purposes, or
  2. an issue titled description, with a label titled metadata, and the body of which should contain only the ideal product description for display purposes; see NCBI-Hackathons/PubRunner#2
• MVP? (required) - if a minimum viable product has shipped, create an issue titled mvp, with a label titled metadata, and the body of which should be only the string true (this makes the repo listed on the NCBI-Hackathons website list of software products); eg, NCBI-Hackathons/ncbi-hackathons.github.io#6
• Manuscript? (optional) - if a manuscript exists for the product, create an issue titled manuscript, with a label titled metadata, and the body of which should be only a string containing the URL to the manuscript; eg, NCBI-Hackathons/ncbi-hackathons.github.io#4

As long as the above three requirements are met, the repo will be included on the NCBI Hackathons list of hackathon products.

For details on how the above data is fetched and used, see https://able-viper.glitch.me/, and https://github.com/brianzelip/ncbi-hackathons/blob/master/test.html#L119.

For the design work in progress using this data, see https://github.com/brianzelip/ncbi-hackathons/.

Questions? Contact @brianzelip.

I vote that we make a 'for attendees' section of the run an ncbi hackathons repo and put this there!

Sounds good