Add README enforcing to all new modules added to contrib repository (Bug #3933)

Added by Steven Puttemans over 10 years ago. Updated almost 10 years ago.

Status:Done Start date:2014-09-30
Priority:Normal Due date:
Assignee:Steven Puttemans % Done:

0%
Category:infrastructure
Target version:3.0
Affected version:branch 'master' (3.0-dev) Operating System:Any
Difficulty: HW Platform:Any
Pull request:https://github.com/Itseez/opencv_contrib/pull/110

Description

I think we should enforce a rule that forces people to add a README to all modules in the GitHub opencv_contrib repository.
Without it will be very hard to know exactly what functionality is provided by these new modules, certainly for new users.

What I suggest is
1) Update the modules README (https://github.com/Itseez/opencv_contrib/blob/master/modules/README.md) to have a list off all modules present with a 1 sentence description
2) Add a README to every single module explaining shortly what is included and what seperate functions are their to be expected

Associated revisions

Revision b4aa37aa
Added by Vadim Pisarevsky almost 10 years ago

Merge pull request #3933 from BKNio:putText_3_0

History

#1
Updated by Vladislav Vinogradov over 10 years ago

  • Category set to infrastructure

#2
Updated by Steven Puttemans over 10 years ago

Pull request will be a work in progress : https://github.com/Itseez/opencv_contrib/pull/110

  • Pull request set to https://github.com/Itseez/opencv_contrib/pull/110

#3
Updated by Steven Puttemans over 10 years ago

  • Assignee set to Steven Puttemans

#4
Updated by Maksim Shabunin almost 10 years ago

  • Status changed from Open to Done
  • Target version set to 3.0
  • Affected version changed from 2.4.9 (latest release) to branch 'master' (3.0-dev)

Also available in: Atom PDF