Page MenuHomePhabricator

GSoC 2022 Proposal: Edit Request Wizard
Closed, DeclinedPublic

Description

Profile Information

Name : Supriya Kumari
Email : supriyakm08@gmail.com
IRC Nick : SupriyaKm08
GitHub : https://github.com/SupriyaKumari08
Location : India
Time Zone : UTC+5:30
Working hours : 10AM- 11PM(UTC+5:30)

Synopsis

The Edit-Request-Wizard is a project aiming to create a step-by-step form to help beginners submit a Wikipedia Edit-Request. It will have a simple front-end with self describing input fields and a strong backend which will use Wikipedia's verification policies and concerned validations to make it accurate.
This project shall guide the new users through the entire process of creating/submitting an edit request aided with high-quality guidance and error messages, suitable to be used by beginners.
The ultimate goal : To make it easy for anyone to become an editor & making the editing part of Wikimedia more accessible for people from all backgrounds.

Possible Mentor(s) : @Enterprisey, @Firefly, @SD0001
I have reached out to @Enterprisey previously.

Timeline

PeriodTask
April 15 to May 4Set up the development environment in the local system, check all the dependencies and study the codebase. Complete the microtasks to get a macroscopic view of the workflow of the project.
May 4 to May 29Community bonding period. Interact and build an understanding with the mentors so as to make the future conversations smooth .Getting to know the community's work ethic and keep up with it. Try to work on existing bugs/issues. Analyse & make rough mock-ups of the UI for the form(to present before the mentors).Make & present algorithmic charts on the flow of the form(respecting its step-by-step nature) as a suggestion from my end. Study and get familiar with Wikipedia’s policies on reliable sources. Keep the documentation platform ready at hand for an easy workflow.
May 30 to June 5Discuss & design the UI of the website with the mentors. Make a sketch-up of the same on figma/Adobe XD(or whichever tool preferred by the mentors) and get it finalized.
June 6 to June 18Code the designed form and implement all the different functionalities of the same. Make a document of my progress .
June 19 to June 23Study about Wikipedia user script.Start coding the backend of the website with the preferred language(Python or Rust or any other technology permitted by the mentor).Document the source policies and the checks to be implemented to make the code work smoothly.
June 22 to June 26Test all the codes which have been written and update my self-progress document along with making changes/enhancements based on feedback provided by the mentors(if any).
June 26 to June 30Phase I evaluation
July 1 to July 10Gather knowledge about MediaWiki Action API & its working and use it to complete the backend of the form.
July 10 to July 11Documentation of the Front-end with a ReadMe and Contributors Guide as well as upload it on GitHub(In the respective repository maintained by me for the project).
July 11 to July 16Finalize the backend and link it with the frontend of the project(form).
July 16 to July 20Receive feedback and do changes if necessary on the codebase which will exist at this point.
July 21 to July 27Test the form with different types of valid and invalid input .Check the validation capability of the input source(backend). Update my self-progress document.
July 28Phase II evaluation
July 29 to August 7Update the readMe and contributors guideline for the whole project . Make a few edit requests to check the feasibility of the same.
August 8 to August 16Make a section for new editors so as to walk them through the process of editing (to be discussed with the mentors).
August 17 to August 21Final testing of the project with the mentors . Update my self-progress document for final evaluation.
August 22 to August 28Complete the project , freeze the code and approach the mentors for any further improvements or enhancements.
August 29 to September 5Handing over the project to the mentor for submission.
September 6Final results of Google Summer of Code 2022 announced

Deliverables

  • Creation of a form which is modular & collaborative in nature, has proper tags so as to make editing easy as well as maintainable by the developers.
  • The front-end technologies used would consist of: HTML5, CSS3 & JavaScript(jQuery) along with some CSS extensions.
  • Framework like React (with the mentor’s permission) can also be used.
  • UX/UI has been one of my ventures , so I will try to make the front-end appealing while maintaining the original layout & feel of Wikipedia.
  • Algorithmic structures elaborating the process of ‘making an edit-request’ (as visual components have more impact and create a better level of understanding).[With mentor’s permission ]
  • Creation of tasks in Phabricator with regular updates.
  • Documenting the progress & being in regular contact with the mentors for feedback & enhancements, assuring a smooth workflow and completion of tasks in targeted time.

Suggestions for the project(optional):

  • I will make a demo (written/ video: whichever approved by the mentors) for the edit request wizard to help the new users know how to go about it.
  • A precise & small pop-up with the do’s of a request , which will be a list of criteria that should be fulfilled so as to get a request implemented. This is done in order to provide the new-users a sense of direction i.e. that they are on the right path.

Phase I evaluation

  • The backend of the project shall be powered by Python.(If the project/mentors require the use of other backend technologies like Rust etc , I am totally comfortable to sharpen my skills in the preferred language of the organization before the coding period begins.)
  • Two step verification process for an edit-request : (i) Validation of the URL, book no (or ISBN) or any other source which shall be provided by the user. (Optional) (ii) Matching that source with the link/context provided in the input field by the user. After passing these two steps the user will get a success message stating the source provided by them is reliable.
  • Complete integration of the user-script with linking the front-end & backend components.
  • Improvements/enhancements in the form based on feedback from the mentors.

Phase II evaluation

  • Run the project through sample test cases and check effectiveness of the code as well as its impact on making the process(for edit-request) smooth.
  • (Additional)Making a few demo edit-requests to check the validation process.(As a part of test-cases)
  • Maintaining the documentation stating the project workflow along with making an update guide as well.
  • Maintain a document of my progress with the organization so as to make it easy-to-evaluate for the mentors.
  • Creation of a Commons page for the purpose of receiving suggestions regarding future enhancements/minor changes.

Participation

  • Making a git repository with 2 branches. Uploading the code in a branch on a regular basis which shall be merged with the main branch once it's reviewed by the mentors.
  • Use Phabricator for creation of tasks and management of bugs/subtasks.
  • Be online on IRC during my working hours(10AM- 11PM(UTC+5:30)) to communicate & collaborate with the mentors.
  • Weekly reports will be published on my meta wiki user page.
  • Available on Gmail as and when needed during the non-working hours.

About Me

Education: I am currently pursuing B.Tech in Chemical Engineering from BIT Mesra, Ranchi, India. I am in the 4rth semester of my 8-semester program and will be graduating in 2024.

Individual background: I am a dedicated and straight-forward person with great aspirations to serve the community in various positive ways.
I heard about this program in a campus open-source guide session & it inspired me a lot.
This opportunity is a boon in many ways like exposure to real world projects(how & what it actually boils down to) , collaboration and communication with the open-source community on a global level. Open-Source motivates individuals to get involved in software-development i.e. Technology and the communities provides a healthy environment as well, thus encouraging more and more individuals. I intend to keep contributing to Open-Source as far as I can think of & this opportunity shall give it a good kickstart.
I am a learner and shall appreciate feedback(if any).

During the summer, GSoC shall be on my priority as I don’t have other commitments during this period.

Internships & Experience: Currently I am doing an internship in a company called All-Rounders[[https://www.all-rounders.in/ ]] as a Web-Development intern.[Duration: 9th Nov 2021-4th May 2022]

I am also a part of GSSoc’22(Girl Script Summer of Code)- A 3 month long open-source program which shall end on 31st May.

Past Experience

I have gained experience with Java, Python, C++, HTML, CSS, JavaScript and on JS frameworks like React, Express frameworks like Node.js as well as Git & GitHub. Among databases ,I have worked on MySQL, MongoDB. My OS preference is Windows.
I have coded a website along with a team for a company called All-Rounders & have chalked out a blog site which shall solve & cater to the day-to-day problems faced by women.

Open-Source- I started my journey with being a part of Hacktoberfest 2021.It has been a great learning opportunity since then.

Some of my PRs are linked below :
https://github.com/Kushal997-das/Project-Guidance/pull/466
https://github.com/Kushal997-das/Project-Guidance/pull/466
https://github.com/surajm-333/Ace-The-FrontEnd/pull/239
https://github.com/2024-SANDHYA/Blood-Buddy/pull/127
https://github.com/khushi-purwar/WebDev-ProjectKart/pull/515
https://github.com/HITK-TECH-Community/Community-Website/pull/702
https://github.com/vinitshahdeo/SimpleBio/pull/164
https://github.com/vinitshahdeo/inspirational-quotes/pull/2503

Microtasks carried out

Microtask-2 under (https://phabricator.wikimedia.org/T300454)
Link: https://www.figma.com/file/DhQzqyAvRol9yOzusVcraH/Microtask-2?node-id=0%3A1
The coded form has also been made.
Microtask-1 -The workflow has been studied and shall be submitted on the site as a demo with concerned Phabricator ticket and required labels.
Microtask-3 is under progress.

Proposal link:

Related Objects

StatusSubtypeAssignedTask
ResolvedNone
DeclinedSupriyaKm08

Event Timeline

Hi! I am Srishti, one of the org admins - it's great to see your interest in applying to GSoC with Wikimedia! You can safely ignore this message if you have already followed our participants' guide. As you develop your proposal, we want to ensure that you follow the application process steps: https://www.mediawiki.org/wiki/Google_Summer_of_Code/Participants#Application_process_steps, primarily communicate with project mentors, integrate their feedback in your proposal, adhere to the guidelines around proposal submission, contribute to microtasks, etc. Let us know if there are any questions!

As the GSoC deadline is soon approaching in less than 24 hours (April 19, 2022, 18:00 UTC), please ensure that the information in your proposal on Phabricator is complete and you have already submitted it on the Google's program website in the recommended format. When you have done so, please move your proposal here on the Phabricator workboard https://phabricator.wikimedia.org/project/board/5716/ from "Proposals in Progress" to the "Proposals Submitted' column by simply dragging it. Let us know if you have any questions.

Gopavasanth subscribed.

@SupriyaKm08 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 75 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 2021 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