Skip to content

Latest commit

 

History

History
49 lines (39 loc) · 1.83 KB

OPEN-SOURCE.md

File metadata and controls

49 lines (39 loc) · 1.83 KB
Raw

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 proper Apache2 LICENSE file.
  • It has a clear and useful README.md
  • It's documented (with examples)
  • It's tested.
  • It has a link to inaka.github.io in its README and/or landing page.

Exhibition

  • It's shared on social networks.
  • It's shared on reddit.
  • It's shared on hacker news with a title like Show HN: description.

For Libraries

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

For Erlang Projects

It follows the rules for our Project Setup

  • proper rebar.config
  • rebar3 compile, dialyzer, doc and ct work with no warnings
  • deps coming from hex.pm
  • elvis.config up to date.
  • Meta testing in place.
  • proper data for hex.pm on app.src

For Elixir Projects

It follows the rules for our Project Setup

  • all default deps in hex.pm
  • proper data for hex.pm on mix.exs
  • travis.yml up to date.

For Erlang/Elixir Projects

For Ruby Projects

  • It's checked with Hound

For Swift Libraries

For Node Projects

  • It's checked with Hound
  • It's published as an npm package.