FOSSASIA

Create a ruby gem for image_checker.rb

OBJECTIVE

image_checker.rb was created in the gci16.fossasia.org repo as a linter. This was useful for the gci16 website, but the script will be useful in gci17 and also to improve old gci websites. To be re-usable, it should be published as a ruby gem. As improvements will be desirable in the future, it should be placed into a separate repository with its own issue tracker.

TASK

This task is to convert that script into a reusable ruby gem.

The first stage is to create a new GitHub repository with the accurate history of this file, which spans from creation, through to its current form after a rename.

This may be done manually by recreating each commit, with correct author and correct date. This involves using git commit --date='...' --author='...'.

The faster approach is to use git fast-export and git fast-import.

The new GitHub repository should initially be GPL-3.0, as the authors all contributed to that script while it was part of the gci16.fossasia.org repository which is GPL-3.0.

The three authors can choose to re-license the repository, but only if they all agree on a new license.

Once the repository has been created, basic tests should be added, with Travis CI integration running the test suite, and additional files as needed to create and publish a gem. See http://guides.rubygems.org/publishing/ for more information on how to create a gem.

The script does not need to be improved for this task. Any improvements needed will be additional tasks.

Task tags

  • git
  • ruby
  • licensing
  • gem

Students who completed this task

Abishek V Ashok

Task type

  • code Code
  • done_all Quality Assurance
close

2016