Page MenuHomePhabricator

Develop a UserScript/Gadget tutorial on MediaWiki.org similar to Wikipedia:The_Wikipedia_Adventure
Closed, DeclinedPublic

Description

Profile Information

Name Bilal Waheed
IRC nickname on Freenode bilalwaheed099
Github https://github.com/bilalwaheed099
Country Pakistan
Typical working hours 10AM - 10PM (GMT +5)

Synopsis

Project Develop a UserScript/Gadget tutorial on MediaWiki.org similar to Wikipedia:The_Wikipedia_Adventure
This project is about to create a guided adventure tour on MediaWiki and MetaWiki to help users on “How to create userscript on Wikimedia projects. This adventure will have 3-4 missions:

  • Mission 1: Basic Intro (About how to write userscripts)
  • Mission 2: Using MediaWiki’s JS module
  • Mission 3: Using MediaWiki API
  • Mission 4: Using OOUI (Optional)
  • Have you contacted your mentors already? No not yet, but I will very soon.

Deliverables

Describe the timeline of your work with deadlines and milestones, broken down week by week. Make sure to include time you are planning to allocate for investigation, coding, deploying, testing and documentation

WeekActivities
May 17th - 23rdGet more insights on how the guided tour works specifically the mediawiki adventure. Discuss queries and project deadlines with mentors.
May 24th - 31stGet more hands-on on the mediawiki tools for guided tours development. Study the APIs and extensions required for the project.
June 1st - 7thCreate a plan for the implementation of mission 1.

Coding

WeekActivities
June 7th - 13thStart with the tour of mission 1. Design the GUI of the tutorial. Work on the story of this tour.
Jun 14th - 20thRefactor, test and bug-fix the code for first tour. Write the documentation of this first phase.
June 21st - 27thTake 1-2 days to plan the design and story of tour for mission 2 . Take 1 day to study mediawiki's JS module. Rest of the week for coding the tour.
May 28th - July 4thRefactor, test and debug the code for mission 2. Write the documentation for this phase.
July 5th - July 11thStart with the tour for mission 3. Learn the concepts of mediawiki API and get some hands-on. Formulate the story for this mission and design the GUI.
July 12th - 18thCode the tour for mission 3.
July 19th - 25thRefactor, debug and improve the code for mission 3. Work on the documentation.
July 26th - Aug 1stCreate a short report of the work done and submit it for feedback from the mentors.
Aug 2nd - 8thDesign the tour for Plan and code the tour of mission 4.
Aug 9th - 15thClean up the all the code and prepare for final submission.

Code submit and Evaluations

WeekActivities
Aug 16th - 23rdGet mentors final feedback and submit for final evaluation.

Participation

Describe how you plan to communicate progress and ask for help, where you plan to publish your source code, etc

I have planned the following points for participation:

  • Most of my communication will be through zulip and email. For help and guidance I will try to arrange meetings with the mentors, or send them emails for their response.
  • I will be using github as a remote repository where all of the code will be maintained.
  • I have not yet decided which task management tool I will use. But I can break the tasks down using Trello and start from there.

About Me

Tell us about a few:

Your education (completed or in progress)

I am a 3rd year student at National University of Science and Technology (NUST), Pakistan.

How did you hear about this program?

In the sixth semester, one of my instructors informed about and guided on how to apply for this program. Before that, I had heard about GSOC from seniors in my university.

Will you have any other time commitments, such as school work, another job, planned vacation, etc, during the duration of the program?

My current semester will go on till the end of June. But during the coding period of the program, I do not have anything planned and I can completely focus on the project until its completion. I can make out more time during the coding weeks than I have mentioned in the working hours.

We advise all candidates eligible for Google Summer of Code and Outreachy to apply for both programs. Are you planning to apply to both programs and, if so, with what organization(s)?

No, I am only applying for Google Summer of Code.

What does making this project happen mean to you?

It would mean a lot to me to work a project related to the biggest encyclopedia (wikipedia). Not only it will be good for my career in future, but it will be the highlight of my student life.

Moreover, the things that are implemented in this project are fairly new to me, so it would be good as a student to push myself and work on that is not native to me. So, it means a lot to me as a software engineering student.

Past Experience

  • Describe any relevant projects that you've worked on previously and what knowledge you gained from working on them.

I have done some frontend projects based on HTML, CSS and JS. I deployed these projects on netlify a while back.

Recipo
This project has frontend along with an API from which recipes are fetched and the relevant information is displayed on the page.
Link: Recipo

Surgery Management System
This is a system for a hospital environment helping doctors, surgeons and other staff keeping the up to date record of patients and their appointments.
Link Surgery Management System

GoCart - E-commerce platform
Link GoCart

  • Describe any open source projects you have contributed to as a user and contributor (include links).

I have not contributed to any open source project before.

  • You must have written a feature or bugfix for a Wikimedia project during the application phase (see the section about microtasks in the application process steps), please link to it here. We give strong preference to candidates who have done so.

Micro Task 1
Create a basic mini tour guide
Micro Task 1

Micro Task 2
Create the tour guide using OOUI and widgets
Micro Task 2

Micro Task 1
Use the mediawiki API
Micro Task 3

Any Other Info

Add any other relevant information such as UI mockups, references to related projects, a link to your proof of concept code, etc

Event Timeline

GSoC application deadline has passed. If you have submitted a proposal on the GSoC program website, please visit https://phabricator.wikimedia.org/project/view/5104/ and then drag your own proposal from the "Backlog" to the "Proposals Submitted" column on the Phabricator workboard. You can continue making changes to this ticket on Phabricator and have discussions with mentors and community members about the project. But, remember that the decision will not be based on the work you did after but during and before the application period. Note: If you have not contacted your mentor(s) before the deadline and have not contributed a code patch before the application deadline, you are unfortunately not eligible. Thank you!

Gopavasanth added a subscriber: Gopavasanth.

@Bilalwaheed099 ​We are sorry to say that we could not allocate a slot for you this time. Please do not consider the rejection to be an assessment of your proposal. We received over 100 quality applications, and we could only accept 10 students. We were not able to give all applicants a slot that would have deserved one, and these were some very tough decisions to make. Please know that you are still a valued member of our community and we by no means want to exclude you. Many students who we did not accept in 2020 have become Wikimedia maintainers, contractors and even GSoC students and mentors this year!

Your ideas and contributions to our projects are still welcome! As a next step, you could consider finishing up any pending pull requests or inform us that someone has to take them over. Here is the recommended place for you to get started as a newcomer: https://www.mediawiki.org/wiki/New_Developers.

If you would still be eligible for GSoC next year, we look forward to your participation