Page MenuHomePhabricator

GSoC Proposal for Improving static analysis tools for MediaWiki
Closed, DuplicatePublic

Description

Personal Information
Name: Hait
Email: hait.gos10@gmail.com
IRC handle: hait
Location: India (Time zone UTC +0530)
Typical working hours: in between 0900 UTC to 2200 UTC

About the project

Synopsis
Currently a phpcs standard exists, except it isn't widely used aside from a few extensions and still isn’t voting. At the same time, phpcs can be made more useful by adding more MediaWiki-specific sniffs. In addition, some of the structure tests (tests/phpunit/structure in core) should become sniffs instead.

Primary mentors:
@Legoktm
@Addshore

Deliverables
The major deliverables of the project are
Sniffs according to the MediaWiki Coding Conventions.
A tool which can check the availability of a method or a function, following the inheritance tree (checking across multiple files).
Sniffs which use the above tool and report error if any method is used where a better/recommended method is available.
Sniffs for some of the structure tests (tests/phpunit/structure in core).

Timeline

  • First I’ll be working on writing sniffs in order to familiarize myself to phpcs and MW CC.
  • Next I’ll work on the tool that can process inheritance trees across files.
  • Then I plan on using this tool in the sniffs.
  • Port the existing structure tests (tests/phpunit/structure in core) to sniffs.

Participation
The source code will be hosted on Gerrit, where it will also be reviewed by mentors. Also, I’ll be in contact with the mentors via IRC, emails and the comments on Gerrit.

About me
I’m currently a second year undergraduate student at International Institute of Information Technology, Hyderabad India.
I heard about the program from friends in college.
I have no other commitments in the summer as of now.
I’ve always been awed by the idea of a community driven encyclopedia and since I lack the knowledge to contribute to the content directly, I would like to use my skills as a developer to contribute to what I also believe to be the awesomest wiki project ever.

Past experience
I’m an experienced PHP developer. I’ve worked on many PHP projects.
I've completed a microtask for this project whose link can be here.
I also have a bit of experience in open source contribution in Mozilla, which can be seen here.
I've built many websites in PHP which includes my college festival website. I also have a good amount of experience programming in JavaScript, Python, C, and C++ along with a decent understanding of Git.

Event Timeline

Hharchani set Security to None.

Hi @Hharchani. Could you breakdown the timeline further and set monthly/bimonthly milestones? It's good to be as elaborate as possible. Thanks.

hashar subscribed.

This is not directly related to the continuous integration project which merely launch PHP CodeSniffer. So it is better tracked solely under MediaWiki-Codesniffer.