Improve documentation for better contributor experience

[Divy123]

We are preparing to participate in Google Code-in, and have reserved this issue for participants in GCI - but we'd love to have your help with another one! Please check out https://code.publiclab.org to see more.

This issue requires providing more test-based examples for a better understanding of code and core API.

[jywarren]

Hi! Perhaps we need a guide to writing tests (either UI or module) so as to encourage this activity as well?

On Mon, Jul 1, 2019 at 5:05 PM Slytherin notifications@github.com wrote:

• Providing more code comments inside core functionality contained in src and test
• Providing a roadmap of our workflow in the codebase which makes it easier for not only the first timers but regular contributors as well.

CC: @jywarren https://github.com/jywarren I request for your guidance on second point listed above.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/publiclab/image-sequencer/issues/1143?email_source=notifications&email_token=AAAF6JYMSKQRPGUCJA2IFO3P5JWOVA5CNFSM4H4V7EDKYY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4G4XOXIQ, or mute the thread https://github.com/notifications/unsubscribe-auth/AAAF6J63A7DRGGLHRJ5QCVLP5JWOVANCNFSM4H4V7EDA .

[Divy123]

Uploaded on GCI dashboard.

[SidharthBansal]

@Divy123 I think you are missing something. It will great if you can kindly visit guidelines for tasks and reformat all of your issues according to the guidelines. Some of the missing things I observed are: Reserved for GCI tagline in BOLD, we use beginner instead of easy. If beginner then it should be in FTO template. I think this should be medium as documentation is a tough to piece to write for the first time at prod level, code links so that students can access the readme.md etc.

Please hide unwanted comments in the issues before uploading them. Once you change your issues then please ping me so that I can publish.

Thanks

[Divy123]

Done here!!

[SidharthBansal]

Published on GCI dashboard

[syobonpastel]

I want to do this task after my task is finished. But I couldn’t understand what to do in this task. What kind of skills will I need? Also what should I do in this task? Thanks.