Fulfil the open-source checklist

Question

Fulfil the open-source checklist

elbrujohalcon opened this issue 9 years ago · comments

Introduction

This is the list of things to check for every open-source project that we create

Usage

Each project should have a github repo with github issues enabled. As the main dev in that project, you should make sure to have the corresponding items from the lists below reported as issues there and work on having them implemented/done before releasing the 1.0 version of your product.

General Items

It has a github repo
It has a proper Apache2 LICENSE file
It's has a clear and useful README.md
It's documented (with examples)
It's tested
It's hooked to a the open-source hipchat room
It has a link to the open-source hipchat room in its README
It has a link to inaka.github.io in its README and/or landing page

Exhibition

There is a blog post about it
It's shared on social networks
It's shared on reddit
It's shared on hacker news with a title like Show HN: description
It has a landing page built in github pages

For Libraries

It provides a sample application
Examples of use are documented in the README or linked from there

For Erlang Projects

It's checked with Gadget
It's shared on Erlang Central