Contributing - Src repository

Vadorequest

I'm currently trying to understand how contribute and I honneslty think that there are not enough documentation.

https://github.com/DataTables/DataTablesSrc

I have no idea how run tests, I installed the requirements but don't have any idea how to use them. (JSlint, closure, (btw, links would be great).

Is there any documentation about the file, the architecture or something like this that could help getting started? There are more than 100K lines of code in the Src repository, I need some doc or guidelines.

The documentation is great to use the Datatable plugin, but to change the source code? or am I missing something?
There is a folder docs but all files are in XML, I guess there is a way to read them but I don't know how. (I just saw it)

I think you should explain more how to get started with the Src repository, how to read the doc, how to test, that's maybe obvious for you, but there are plenty different way to test using a lot of different frameworks. Or maybe the tests are run on build?

I'll try to understand,but more guidelines would be appreciated.

allan

I honneslty think that there are not enough documentation.

There isn't. I'm still working on it. Unfortunately there is only one me and so much to do! I will get around to it, but there are other things I need to do first unfortunately.

The whole build src repo needs to be improved for building - checked to find the closure path, jshint, tests etc.

I guess there is a way to read them but I don't know how. (I just saw it)

Those are the source files for the reference pages on this site. I run them through an build script to populate the site.

I think you should explain more how to get started with the Src repository

I 110% agree! This and updated developer documentation for 1.10 are important - I just need to get to them!

Allan

Vadorequest

I finally manage to compile, didn't know bash, nor closure.

\033[0;36m DataTables build (1.10.1-dev) - branch: master\033[0m

\033[0;36m JS\033[0m
\033[0;32m JSHint passed\033[0m
\033[0;36m JS min\033[0m
/media/ayolan/Data/Dev/DataTablesSrc/build/../built/js/jquery.dataTables.js:6198: WARNING - Parse error. Non-JSDoc comment has annotations. Did you mean to start it with '/**'?
/*
^

0 error(s), 1 warning(s)
\033[0;32m File size: 76586\033[0m

\033[0;36m Done\033[0m

I guess I have to execute the code around this place to apply the html5 data attributes by default, before the javascript options is applied. I think that's in the core.constructor.js file, not sure exactly where, I'll continue tomorrow, to see if I'm able to understand when and how apply the data-attributes.

https://github.com/Vadorequest/DataTablesSrc/commit/04809af28346162d199a014a9c0d273baa0d66f2

allan

This is for our discussion about using HTML5 data attributes is it? That's not something I'm likely to accept into the core file unless you can do it in very very few bytes. I want to keep the core modular (in fact v1.11 is going to modularise the internals, so if you don't want sorting, you don't need the sorting code, etc) to keep the library trim rather than just adding more and more features.

That's why I mentioned in your other thread that I had planned to do this as a plug-in. In fact, I would probably go so far as saying that you probably just want a function - give it the table to be initialised and return the object which is passed to the existing DataTables constructor.

Allan

Vadorequest

Yes it is. I understand.