Re: [GSOC] Contributing to git.

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



>> >     1. Where can I find general instructions on "Contributing to git? "
>> > more specifically, gitweb?
>>
>> Documentation/SubmittingPatches in the git.git repository.

Generally informative, thank you.

> For GSoC we prefer if you had a public git repository with your stuff
> (GitHub, repo.or.cz or wherever), and that patches were Cc-ed to mentor.

I just started some experiments with code. I branched 'gsoc'  from
'next' and pushed to github. From the docs I understand that I should
have branched from master. What should I be doing now?
[github clone](https://github.com/jaseemabid/git/tree/gsoc)


>> >     2. Where can I find coding standards for git? I am looking for the
>> > git version of this document.
>>
>> Documentation/CodingGuidelines
>
> There are no special rules for JavaScript (and neither for that matter
> for Perl), but:

Parts of my mail are not quoted so I'm mentioning some points again.

Since we don't have a strict coding guidelines for JavaScript till
now, and since we are thinking of an almost rewrite, I would suggest
that we can follow guidelines from the Jquery project.
[http://docs.jquery.com/JQuery_Core_Style_Guidelines]. Since this is
the library we are going to use mostly, I think this will be a good
choice, considering we might write few plugins ourselves for the
project.

[Tips from Douglas
Crockford](http://javascript.crockford.com/code.html ) are very
important in the context of JavaScript. Following this will make it
pass [JSLint](http://www.jslint.com/) which is a good measure for
JavaScript code quality. Will try to make sure that every piece of
JavaScript I write pass JSLint (which is not very easy). I think it is
like the POSIX example from Documentation/CodingGuidelines for C :P

I have tried to follow these till date and wont be hard to continue
doing it for gitweb.

> For JavaScript this includes using subset of JSDoc in comments.

[JSDoc]((http://code.google.com/p/jsdoc-toolkit/)) tool kit seems like
a very good choice.

>> >     3. Is JavaScript code unit tested? I cant find much docs regarding
>> > this anywhere.

> The problem with automated testing of JavaScript is integrating it with
> our testsuite, which is run from command line and outputs TAP (Test
> Anything Protocol), so it can e.g. be run by 'prove'.

This is what I proposed originally,

		I have shortlisted the following for JavaScript unit testing in
priority order.
		[JSDev by Douglas
Crockford](https://github.com/douglascrockford/JSDev) for its
simplicity and elegance.
		[Jasmine](http://pivotal.github.com/jasmine/) for its power.
		[Sinon.js](http://sinonjs.org/)	- overall goodness.

After reading through the mail and the TAP requirement, I would love
to recommend JSDev and [node.js](http://nodejs.org/) for this task. I
think it can be integrated with TAP well afaik. I need to learn more
about TA. I wont be able to confirm something without knowing much
about it now. I know that we should not be adding more requirements to
git project, but node.js seems trivial for testing JavaScript in a
terminal. Since not many will be developing JavaScript for gitweb, I
dont think its a bad idea.

> But even if the JavaScript tests would have to be run in browser

Not necessarily.


-- 
Jaseem Abid
+91 8891 72 43 72
S6 CSE student
National Institute of Technology , Calicut.
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]