jollygoodcode/Open_Source_Checklist

:white_check_mark: Open Source Checklist

Open Source Checklist

Copy-paste friendly version.

Get all templates to local

ruby <(curl -sSL https://git.io/vzmvV) all

Single template also can, see usage:

ruby <(curl -sSL https://git.io/vzmvV)

General

• README file
  • Keep README short
  • Badges from CI, Code Coverage, Code Climate etc
    • https://github.com/badges/badgerbadgerbadger
    • http://shields.io/
  • Why? What is this project? What problem it solved?
  • Known issues if any
  • Features
  • Usage / Synopsis
  • Roadmap / Todos
  • How to Contact (IRC, Gitter, Slack, Mailing List)
  • Link to CONTRIBUTING.md
  • Link to LICENSE
  • Link to DEPLOYMENT.md
  • Credits
• CHANGELOG file
  • http://keepachangelog.com
  • Follow SemVer 2.0 http://semver.org
• CONTRIBUTING file
  • General Guidelines
  • How to Set Up Development Environment?
  • How to Run Test Suite?
  • How to Run Extra Scripts (Linters)?
  • How to Release?
  • Contributor License Agreement (CLA)
  • This file is special on GitHub
• DEPLOYMENT file (Optional)
  • How to Deploy?
• LICENSE file
  • http://choosealicense.com
  • Year
  • Author(s) Name
• Code of Conduct
  • http://contributor-covenant.org/version/1/3/0/code_of_conduct.md
• Wiki (Optional)
• Tests
  • All passed!
• CI Service
  • Setup Travis CI
  • Badge in README
• Code Climate Service
  • Setup Travis CI
  • Badge in README

All files are in markdown format (.md).

RubyGem Specific

• Remove tests/specs from packaged gem Why?

Rails Specific

• Remove sensitive data
• Remove unnecessary code