Image-sequencer: Standardise Util Functions Comments

[harshkhandeparkar]

Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open-source software!

We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

If you have contributed before, consider leaving this one for someone new, and looking through our general help wanted issues. Thanks!

What is to be done?

We are working towards standardizing all the comments in the codebase to make the docs look professional. New developers will get benefitted if we add comments to some of the most commonly used util functions. They are listed below.

1. pixelSetter.js
2. getDefaults.js

You will have to update the comments in the above files based on the guidelines mentioned below.

1. Methods must be described using JSDoc comments
2. Misc code comments should be inline unless it is a long sentence.
3. No use of continuous tenses, no pronouns.
4. No redundant comments.
5. Each comment should start with an uppercase letter and end with a full stop.

🤔 What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

📋 Step by Step

• [ ] 🙋 Claim this issue: Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!

• [ ] 📝 Modify the file pixelSetter.js

• [ ] 📝 Modify the file getDefaults.js

• [ ] 💾 Commit your changes

• [ ] 🔀 Start a Pull Request. There are two ways how you can start a pull request:

1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.

2. You can also edit files directly in your browser and open a pull request from there.

• [ ] 🏁 Done Ask in comments for a review :)

Please keep us updated

💬⏰ - We encourage contributors to be respectful to the community and provide an update within a week of claiming a first-timers-only issue. We're happy to keep it assigned to you as long as you need it if you update us with a request for more time or help, but if we don't see any activity a week after you claim it we may reassign it to give someone else a chance. Thank you in advance!

If this happens to you, don't sweat it! Grab another open issue.

Is someone else already working on this?

🔗- We encourage contributors to link to the original issue in their pull request so all users can easily see if someone's already started on it.

👥- If someone seems stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!

🤔❓ Questions?

Leave a comment below!

[harshkhandeparkar]

@publiclab/is-reviewers

[iblalw17]

Can I claim

[harshkhandeparkar]

Sure

On Fri, 27 Dec, 2019, 5:11 PM iblalw17, [e-mail] wrote:

Can I claim

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
https://github.com/publiclab/image-sequencer/issues/1396?email_source=notifications&email_token=AIJI5H7SH34474H545QOAHTQ2XSVVA5CNFSM4J7MPLM2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHXBXII#issuecomment-569252769,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AIJI5H4EQSTEOJTOF3GC42DQ2XSVVANCNFSM4J7MPLMQ
.

[hedonhermdev]

Hey @iblalw17 are you working on this?

[iblalw17]

I haven’t started it, I’m new to this so don’t know what to do

Get Outlook for iOShttps://aka.ms/o0ukef

---

From: Tirth Jain [e-mail]
Sent: Monday, December 30, 2019 9:00:16 AM
To: publiclab/image-sequencer [e-mail]
Cc: iblalw17 [e-mail]; Mention [e-mail]
Subject: Re: [publiclab/image-sequencer] Standardise Util Functions Comments (#1396)

Hey @iblalw17https://github.com/iblalw17 are you working on this?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://github.com/publiclab/image-sequencer/issues/1396?email_source=notifications&email_token=ALS6RXD3TVQ2VI2P63H6F7DQ3G2CBA5CNFSM4J7MPLM2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEHZ3FQQ#issuecomment-569619138, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ALS6RXAI2CWQMVHOFTTQJOLQ3G2CBANCNFSM4J7MPLMQ.

[hedonhermdev]

Ping me if you need any help, maybe I can help you out.

[iblalw17]

It isn’t let me edit the documents for some reason, I clicked edit but it’s not responding

Get Outlook for iOShttps://aka.ms/o0ukef

---

From: Tirth Jain [e-mail]
Sent: Tuesday, December 31, 2019 5:00:30 AM
To: publiclab/image-sequencer [e-mail]
Cc: iblalw17 [e-mail]; Mention [e-mail]
Subject: Re: [publiclab/image-sequencer] Standardise Util Functions Comments (#1396)

Ping me if you need any help, maybe I can help you out.

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://github.com/publiclab/image-sequencer/issues/1396?email_source=notifications&email_token=ALS6RXGN3HOVQWPDNRAMT7TQ3LGW5A5CNFSM4J7MPLM2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEH3XBYI#issuecomment-569864417, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ALS6RXCVFNPNQNISPKQHCPLQ3LGW5ANCNFSM4J7MPLMQ.

[hedonhermdev]

Are you using a text editor? If yes then which one? Also which documents are you trying to edit?

[harshkhandeparkar]

I think we'll have to add cloning and committing instructions to our FTO template.

[hedonhermdev]

Yes that will be a good idea, or linking to a good introduction to Git/GitHub would be nice too, imo.

[harshkhandeparkar]

Is there an online article that we can link to?

[hedonhermdev]

https://guides.github.com/activities/hello-world/ How about this one?

[harshkhandeparkar]

Yeah, nice. Do you want to open a PR that makes these changes to the FTO template?

[hedonhermdev]

Sure, I’ll do that.

On Tue, 31 Dec 2019 at 7:05 PM, Harsh Khandeparkar [e-mail]
wrote:

Yeah, nice. Do you want to open a PR which makes these changes to the FTO
template.

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
https://github.com/publiclab/image-sequencer/issues/1396?email_source=notifications&email_token=AFRPNJ5VM4CWVONAGBKSGJ3Q3NDDLA5CNFSM4J7MPLM2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEH4G7VA#issuecomment-569929684,
or unsubscribe
https://github.com/notifications/unsubscribe-auth/AFRPNJ7HQTQ72NOCBDTMM33Q3NDDLANCNFSM4J7MPLMQ
.

[udaan42]

Hello, is this issue still open? I would like to contribute if this issue is open. Thanks.

[harshkhandeparkar]

If @iblalw17 is no longer working on this, you can start work on it.

[udaan42]

Hey @iblalw17. Could you please confirm if you are working on this ? Thanks

[iblalw17]

Feel free to work on

Get Outlook for iOShttps://aka.ms/o0ukef

---

From: Adithya R [e-mail]
Sent: Monday, January 13, 2020 3:09:29 PM
To: publiclab/image-sequencer [e-mail]
Cc: iblalw17 [e-mail]; Mention [e-mail]
Subject: Re: [publiclab/image-sequencer] Standardise Util Functions Comments (#1396)

Hey @iblalw17https://github.com/iblalw17. Could you please confirm if you are working on this ? Thanks

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://github.com/publiclab/image-sequencer/issues/1396?email_source=notifications&email_token=ALS6RXDKFFN5BVUOVXENASTQ5R72TA5CNFSM4J7MPLM2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEIZBW7A#issuecomment-573709180, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ALS6RXGOYXG2NDPGIIPICYLQ5R72TANCNFSM4J7MPLMQ.

[iblalw17]

I am not working on it

Get Outlook for iOShttps://aka.ms/o0ukef

---

From: Iblal Waheed [e-mail]
Sent: Monday, January 13, 2020 4:04:10 PM
To: publiclab/image-sequencer [e-mail]; publiclab/image-sequencer [e-mail]
Cc: Mention [e-mail]
Subject: Re: [publiclab/image-sequencer] Standardise Util Functions Comments (#1396)

Feel free to work on

Get Outlook for iOShttps://aka.ms/o0ukef

---

From: Adithya R [e-mail]
Sent: Monday, January 13, 2020 3:09:29 PM
To: publiclab/image-sequencer [e-mail]
Cc: iblalw17 [e-mail]; Mention [e-mail]
Subject: Re: [publiclab/image-sequencer] Standardise Util Functions Comments (#1396)

Hey @iblalw17https://github.com/iblalw17. Could you please confirm if you are working on this ? Thanks

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://github.com/publiclab/image-sequencer/issues/1396?email_source=notifications&email_token=ALS6RXDKFFN5BVUOVXENASTQ5R72TA5CNFSM4J7MPLM2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEIZBW7A#issuecomment-573709180, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ALS6RXGOYXG2NDPGIIPICYLQ5R72TANCNFSM4J7MPLMQ.

[udaan42]

Thank you. I will start working on this.

[tanish14]

Is this issue still open? I would like to contribute if this issue is open. Thanks.

[harshkhandeparkar]

The last comment was quite old, you may take it :)

[tanish14]

@HarshKhandeparkar can you pls review the PR. Thanks :)