[Neurodebian-devel] Code Ready to Commit

[Yaroslav Halchenko]

Hi Mehmet,

Some feedback I hope you find useful.

I guess I need to spend more time to see/help making stock Debian
RTAI/Comedi usable for building your project on a Debian system.
Meanwhile I have filed few relevant bug reports

http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=606122
http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=608091

and will look into helping with them whenever time permits (unless
original maintainers of RTAI and comedi take care about them)

* GIT
you might like to set your real name/email for your commits, i.e.

$ git config --global user.name "Firstname Lastname"
$ git config --global user.email "real at email.com"

* License

It is great that you have included minimalistic license description in
the header of each file, but please also provide a complete copy of
GPL license in COPYING file in the root of the project.

* Version

So, lets call it 0.1 ?
  git tag -a -m "Initial release" 0.1    # or use -s if you have GPG key
  git push --tags

You might also like to initiate ChangeLog file describing current
version and summary of changes for consecutive ones

* README

Indeed, if you could provide a top-level README.txt which would
briefly describe 4 included components, and basic instructions on the
dependencies (RTAI, comedi, gtkdatabox, ...) it would be
great. Moreover github would visualize it on the repository's main
page.

* Minor
 * not-functional, but though you might like to take care:
   you have a mix of Linux (just CR) and windows (CRLF) line endings,
   e.g. in ChannelReviewer.c

   you could enforce consistent endings with .gitattributes
   or just run dos2unix on those and commit


With best regards,
Yarik

On Wed, 22 Dec 2010, Mehmet Kocaturk wrote:

> Hi Yarik,

> I could submit the code : https://github.com/globalvariable/BlueSpike

> I couldn' t prepare a ReadMe file but I am going to prepare it as soon as
> possible.

> I just wanted to inform you.

> Best,
> Mehmet
-- 
Yaroslav O. Halchenko
Postdoctoral Fellow,   Department of Psychological and Brain Sciences
Dartmouth College, 419 Moore Hall, Hinman Box 6207, Hanover, NH 03755
Phone: +1 (603) 646-9834                       Fax: +1 (603) 646-1419
WWW:   http://www.linkedin.com/in/yarik