Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GCI] Standardised UI code comments #1345

Merged
merged 14 commits into from
Jan 1, 2020
Merged

[GCI] Standardised UI code comments #1345

merged 14 commits into from
Jan 1, 2020

Conversation

harshkhandeparkar
Copy link
Member

@harshkhandeparkar harshkhandeparkar commented Dec 9, 2019

Fixes #1338 (<=== Replace 0000 with the Issue Number)

Make sure these boxes are checked before your pull request (PR) is ready to be reviewed and merged. Thanks!

  • tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR -- or run tests locally with npm test
  • code is in uniquely-named feature branch and has no merge conflicts
  • PR is descriptively titled
  • ask @publiclab/is-reviewers for help, in a comment below
  • Insert-step functionality is working correct as expected.

We're happy to help you get this ready -- don't be afraid to ask for help, and don't be discouraged if your tests fail at first!

If tests do fail, click on the red X to learn why by reading the logs.

Please be sure you've reviewed our contribution guidelines at https://publiclab.org/contributing-to-public-lab-software
Please make sure to get at least two reviews before asking for merging the PR as that would make the PR more reliable on our part
Thanks!

@codecov
Copy link

codecov bot commented Dec 9, 2019

Codecov Report

Merging #1345 into main will not change coverage.
The diff coverage is 0%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1345   +/-   ##
=======================================
  Coverage   66.12%   66.12%           
=======================================
  Files         125      125           
  Lines        2571     2571           
  Branches      404      404           
=======================================
  Hits         1700     1700           
  Misses        871      871
Impacted Files Coverage Δ
examples/lib/intermediateHtmlStepUi.js 11.11% <0%> (ø) ⬆️
examples/lib/defaultHtmlStepUi.js 10.73% <0%> (ø) ⬆️

examples/demo.js Show resolved Hide resolved
examples/demo.js Outdated Show resolved Hide resolved
examples/demo.js Outdated Show resolved Hide resolved
@SidharthBansal
Copy link
Member

Kindly resolve conflicts.

@harshkhandeparkar
Copy link
Member Author

Resolved!

examples/demo.js Outdated Show resolved Hide resolved
@SidharthBansal
Copy link
Member

Resolved!

Suggestion: Please review your PRs before they are reviewed by any mentor. This will save a lot of time. It will waste a lot of your time I will suggest you same changes again and again but you will do only some of those changes.

Also, regarding the comment for asking mentors to be fast. I will say your pr is reviewed within 6 hours. This year GCI is EPIC so we are really fast.
Remember haste makes waste. The best things take time. I changed this issue to hOF as I knew this will take time. The ideal time for hall of fame is 10 days+. The ideal time to review a PR is within 12 hours if on priority for GCI. So, you are doing a great job. 🚀

Thanks

@harshkhandeparkar
Copy link
Member Author

I was a bit worried because of school timings. It seems I will have some free time so no worries anymore. I won't ask anyone to be fast or anything.(I myself am not fast)

@SidharthBansal
Copy link
Member

SidharthBansal commented Dec 12, 2019 via email

@harshkhandeparkar
Copy link
Member Author

Uh. Check what online?

examples/demo.js Outdated Show resolved Hide resolved
examples/demo.js Outdated Show resolved Hide resolved
@harshkhandeparkar
Copy link
Member Author

I can't believe, this issue had about a googol issues

@harshkhandeparkar
Copy link
Member Author

harshkhandeparkar commented Dec 12, 2019 via email

@harshkhandeparkar
Copy link
Member Author

Fixed.

@harshkhandeparkar
Copy link
Member Author

Email replies are messed up. Github needs to fix this.

Copy link
Member

@SidharthBansal SidharthBansal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have indicated all the places where . is inappropriate. If you are writing paragraph or sentence then only use full stops. Setting/Getting/Inserting doesn't require any full stop as they are phrases. If you are write function x is setting Y then you can use full stops.
Thanks
Small change will take 2-3 minutes. Lets complete it fast and merge it

examples/demo.js Outdated
var modulesInfo = sequencer.modulesInfo();

var addStepSelect = $('#addStep select');
addStepSelect.html('');

// Add modules to the addStep dropdown
// Add modules to the addStep dropdown.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Add modules to the addStep dropdown.
// Add modules to the addStep dropdown

examples/demo.js Outdated Show resolved Hide resolved
examples/demo.js Outdated Show resolved Hide resolved
examples/demo.js Outdated Show resolved Hide resolved
examples/demo.js Outdated Show resolved Hide resolved
examples/lib/defaultHtmlStepUi.js Outdated Show resolved Hide resolved
examples/lib/defaultHtmlStepUi.js Outdated Show resolved Hide resolved
examples/lib/defaultHtmlStepUi.js Outdated Show resolved Hide resolved
examples/lib/defaultHtmlStepUi.js Outdated Show resolved Hide resolved
examples/lib/defaultHtmlStepUi.js Outdated Show resolved Hide resolved
Copy link
Member

@SidharthBansal SidharthBansal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jywarren kindly merge it

@harshkhandeparkar
Copy link
Member Author

@jywarren resolved the conflicts.

@jywarren
Copy link
Member

jywarren commented Jan 1, 2020

This one next!

Copy link
Member

@jywarren jywarren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is wonderful! Fantastic work, @harshkhandeparkar !!!

@jywarren jywarren merged commit 1af9655 into publiclab:main Jan 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Standardise UI code comments
3 participants