Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fulfil the open-source check-list #1

Closed
18 tasks done
elbrujohalcon opened this issue Jul 3, 2015 · 0 comments
Closed
18 tasks done

Fulfil the open-source check-list #1

elbrujohalcon opened this issue Jul 3, 2015 · 0 comments
Assignees
@jfacorro

Comments

@elbrujohalcon
Copy link
Member

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
    • with the proper copyright: 2015 Erlang Solutions Ltd.
  • 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
cabol added a commit that referenced this issue Aug 18, 2015
@cabol
[#1] Fulfil the open-source check-list: implemented example.
8a22632
@cabol cabol mentioned this issue Aug 18, 2015
Merged
cabol added a commit that referenced this issue Aug 18, 2015
@cabol
[#1] Fixed PR comments.
700bd8c
elbrujohalcon pushed a commit that referenced this issue Aug 18, 2015
Merge pull request #15 from inaka/cabol.1.fulfil_open_source_list
352d8bf 
[#1] Fulfil the open-source check-list: implemented example.
cabol added a commit that referenced this issue Aug 19, 2015
@cabol
[#1] Fixed README.
062b0d1
cabol added a commit that referenced this issue Aug 19, 2015
@cabol
[#1] Fixed link in README.
7584bc3
@cabol cabol mentioned this issue Aug 19, 2015
Merged
cabol added a commit that referenced this issue Aug 19, 2015
@cabol
[#1] Fixed PR comments.
ab5a143
elbrujohalcon pushed a commit that referenced this issue Aug 19, 2015
Merge pull request #17 from inaka/cabol.1.fulfil_open_source_list
f67e82b 
[#1] fulfil open source list: README.
elbrujohalcon pushed a commit that referenced this issue Aug 20, 2015
Merge pull request #21 from inaka/cabol.1.fulfil_open_source_list
09511a6 
[#1] Fixed documentation in modules. Fixed README.
@cabol cabol mentioned this issue Aug 20, 2015
Merged
elbrujohalcon pushed a commit that referenced this issue Apr 30, 2018
@freke
fixed dialyser error 'no local return' then definition includes an ar…
ca052e0 
…ray (#80) (#1)

* fixed dialyser error 'no local return' then definition includes an array

* fixed indentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jfacorro jfacorro

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@elbrujohalcon @jfacorro