Updates on Hurricane Ida? Join us for Open Call every Tuesday at 2pm Central Time Click here for call-in details!

Public Lab Research note


Outreachy proposal: Comment Editor Overhaul Project.

by tawah_peggy | November 06, 2020 13:15 06 Nov 13:15 | #24939 | #24939

About me

Name: Tawah Peggy Che Nico

Email : tawahpeggy98@gmail.com

_Github: _https://github.com/tawahpeggy

Time Zone: GMT +1

Location: (cameroon)

Passion: i am passionate about Using Technology to better Humanity

favourite meal: Achu

sports: Lawn Tennis

sex:female

It is a pleasure to be here, learning from such many great minds.

Project description

PublicLab.Editor is a general purpose, modular JavaScript/Bootstrap UI library for rich text posting, which provides an author-friendly, minimal, mobile/desktop (fluid) interface for creating blog-like content, designed for PublicLab.org (itself an open source project).

PublicLab.Editor provides author-friendly interfaces for:

  • titling
  • main image uploading
  • text body editing using Woofmark (markdown/WYSIWYG)
  • tagging
  • edit history.so the comment Editor overhaul project has as a basic description: Take the public lab Editor, particularly the comment Editor subsection and examine, break into parts and repair broken pieces through bubfixes,refining and repairing, hence making it more readable,maintanable,reliable,compactible with other frameworks and hence adapting it to meet basic good coding practices.

summary

i will like to be given the opportunity to work on the comment Editor so i can make it better , maintanable reliable and bug free. The Editor as a whole is a great initiative and i will like to see it flawless.

Problem

publiclabs is an outstanding idea with a very large codebase and even so many technologies and programming languages combined and so the comment editor is used in variants with shared code.hence complicating debugging by maybe fixes done on a section initiate an error or bug in another section. i am here to solve that in the best way possible.

Timeline

Based on the interns task outlined here: _https://pad.publiclab.org/p/outreachy, i will do everything in my power to follow this weekly agenda stated below perfectly unless or otherwise unforeseen circumstances,or adhear to any changes if my mentors think otherwise.

Week 1:

-Before the internship begins and one week into it, i will take out time to fix some things i noticed were not done using best coding practices on the Editor section like variable naming and linting .

-create first timers only issue and bug issues with respect to the bugs i will find due to the tests ran.

week 2:

-create first timers only issues and bugs issues with respect to the bugs i will find due to the tested ran.

-i will also fix some bugs my self.

Week 3:

-Remove template buttons to simplify code.

-Ensure recovery is consistently working.

-Make all comment Editors consistent among variants'.

Week 4:

-Write system tests to confirm basic functionality in comment, comment response, question comment, question comment response, editing all above types and editing/using all above types after having just posted them using AJAX.

-Explore comment types on the test server.

Week 5:

consolidate and organise test, so each type of test can be ran on each variant on the comment editor.

week 6:

-Organise code to simplify, reduce and ease maintenance.

-talk with my mentor on weather spinning the Editor out like other libraries make sense.

week 7

-work on image upload.

-already known issues include:

-Image upload doesn't begin on note comment #4617

-Display image in upload section #3558

week 8

-work on rich text entry.

known issues include:-Integrate new autocompletion code from PublicLab.Editor #4798,-Editor bottom-bar takes up a lot of space on mobile: let's compact it #4776

-non-unique id in comment form - possibly related to comment bugs #4771,

-Rich_wiki new action #2542

Week 9:

-work on Save and Preview Text.

some issues already existing include:

-WIKI "Preview" state does not show a way to go back to editing #7112,

-Blurred value not saved sometimes #120,

-Issues with the search functions and lack of input sanitization #4943.

week 10

-write test on image upload

-write test on rich text entry

-write test on save and preview text.

week 11

make first timers only issues and Bug issues on bugs found after running the test found while running the test.

Solve some bugs.

week 12

-Talk with my mentor so i can move to the authentication part of the application if accepted: run test and come up with first timers only issues and bug issues with respect to authentication.

issues on authentication include:

-Detect a login cookie and show Signup form unless a browser has logged in before? #6338

week 13

-solve issues i can handle.

suggest better practices to my mentor and if accepted i implemented them not from scratch though just make code more readable and accessible.

week 14

anything my mentor thinks i can do will be fine.

i cant wait to start this internship because from all this tasks i see a wonderful possibility to transform my life through learning and a massive contribution to a free and open project, even a better one which works in accordance to making the world a better place.

also i have been into Angular 7+ for 1 and a 1/2 years now both while i was still in school and during academic and professional internship seasons. so when i decided to join this community i started learning react As soon as possible.so granting me this opportunity for internship and choosing the react implementation approach is what you don't want to miss.

Needs

Public Labs is made up of a great team and i will love if you all can give me a hand each time i need one so this internship can be a blast.

First-time contribution

helping others is what i have grown to love and admire so i try my best to help people as often as possible. i never see someone needing help and and turn a blind eye to it. i try my best to always help my fellow open source first timers and contributors always even if it means doing a little more research when they need help.

below is a list to some of my contributions Ihave made to Publiclabs.


Teamwork

I have been working on projects though private since 2years now, though i recently just graduated as a software engineer i have done lots of both academic and professional internships at prestigious companies.

i have great communication skills with my first language been Enggish and i have worked with team members where we sometimes had to use one machine and do pair programming.

Experience

Javascript is my base language but i understand a couple of other languages as i have been experimenting alot. i have worked with Angular 7+ for 1 and 1/2 year and when i saw this project and how welcoming everyone at the publiclab were i decided to start learning react which i am already getting a hand on it since is isnt very different from Angular.

RubyonRails is pretty new to me but i have started learning it already and catching up isn't going to a whole lot of struggle.

i have used the following :

HTML

CSS

Python(flask)

Javascript (Angular 7+, react)

Wordpress

RubyOnRails.

Git(version control)

_github link for reference: _https://github.com/tawahpeggy?tab=repositories

Motivation

I love programming above all helping other succeed.

I draw my strength from the marginalization i and other females receive in my community as women in technology. i really want to do something about always been looked down on as not been able to bring something tangible to the world of technology as a female.

Audience

my plan is to satisfy all public lab users especially those using the Editors for a better experience and to continue the trend which is making public labs a place like home for all its users and contributors.

Commitment

I actually understand that this internship is a serious commitment and i have cleared out all my activities for the time frame and will be committed to contributing to this project from now till the end of the internship and beyond.


2 Comments

Hi @tawah_peggy! Thanks for your proposal! A couple suggestions - first, it's good to note that first-timers-only issues do take a lot of time to support people on, so perhaps it's good to moderate the quantity of them you create in your first week or two - it could end up taking most of your time! Also, it's easier to review FTOs when tests exist, so you don't have to try out the changes manually. But i love that you've built in newcomer welcoming into the earliest stages of your plan - great!!

Second, i would guess you'll run into some of the image upload issues when you begin writing tests. So there may be some overlap between the system test week and the image upload week - ideally, the process of writing thorough system tests will help you expose the bugs in upload, and by solving the bugs, you'll complete and pass the tests. This is like test-driven-development, kind of -- writing tests first - except that the bugs are already in our live app (whoops! 😝 ).

Anyways thank you for a great proposal, we really appreciate it!

Thanks a whole lot @jywarren for the remarks, i will modify the proposal as soon as possible. and i do think a test-driven coding practice is great as we have the opportunity to see bugs and do away with them before they show up. also i did know that FTOs are a great way to let others understand the plan of action but as you said they will have to be limited so i dont spend my whole first two weeks grooming newbies.i could groom a few but not too many. i copy clearly. Thanks a bunch.

On Mon, Nov 9, 2020 at 4:57 PM \<notifications@publiclab.org> wrote:

Hi! There's been a response to your research note 'Outreachy proposal: Comment Editor Overhaul Project.'. You can reply to this email or visit this link:

https://publiclab.org/notes/tawah_peggy/11-06-2020/outreachy-proposal-comment-editor-overhaul-project#c27642

warren wrote:


Hi @tawah_peggy! Thanks for your proposal! A couple suggestions - first, it's good to note that first-timers-only issues do take a lot of time to support people on, so perhaps it's good to moderate the quantity of them you create in your first week or two - it could end up taking most of your time! Also, it's easier to review FTOs when tests exist, so you don't have to try out the changes manually. But i love that you've built in newcomer welcoming into the earliest stages of your plan - great!! Second, i would guess you'll run into some of the image upload issues when you begin writing tests. So there may be some overlap between the system test week and the image upload week - ideally, the process of writing thorough system tests will help you expose the bugs in upload, and by solving the bugs, you'll complete and pass the tests. This is like test-driven-development, kind of -- writing tests first - except that the bugs are already in our live app (whoops! 😝 ). Anyways thank you for a great proposal, we really appreciate it!


Look like spam? Flag this for moderators

Reply at: https://publiclab.org/notes/tawah_peggy/11-06-2020/outreachy-proposal-comment-editor-overhaul-project#c27642

Report abuse to: moderators@publiclab.org

Check out the blog at [https://publiclab.org/blog](https://publiclab.org/blog) | Love our work? Make a one-time or recurring donation at [https://publiclab.org/donate](https://publiclab.org/donate) If this email title has an ID in the format [#0000](/n/0000), you can reply with the email you use at PublicLab.org and your response will be posted as a comment on the website.

Is this a question? Click here to post it to the Questions page.


Reply to this comment...


Login to comment.