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

Go through theme and make list of all places where "TODO" "TO DO" and "XXX" appear #963

Open
5 tasks
benlk opened this issue Nov 10, 2015 · 7 comments
Open
5 tasks
Labels
good for beginners priority: low Nice-to-have in a release.

Comments

@benlk
Copy link
Collaborator

benlk commented Nov 10, 2015

A lot of older Largo files have notes to future developers, but these notes and issues aren't captured anywhere.

Common marks for these notes are:

  • TO DO
  • TODO
  • @todo (in a docblock)
  • XXX
  • TKTK

When conducting this review, use the develop branch.

@benlk benlk added priority: low Nice-to-have in a release. good for beginners labels Nov 10, 2015
@aschweigert aschweigert added this to the Backlog milestone Nov 30, 2015
@yayannabelle
Copy link

I'd like to take this on! Assuming I'm understanding it right, of course. Go through files in the develop branch -> find to-do notes -> compile notes and their locations in an .md file and add it into the branch?

@benlk
Copy link
Collaborator Author

benlk commented Oct 4, 2016

Instead of adding the notes as a file in the branch, could you just leave them in a response to this ticket? That would work best with our workflow.

There's also probably a few comments like this that aren't tagged with the marks listed above, which would make them harder to find. If you run across any of those, filing a pull request that adds @TODO in the comment would be a great boon to us.

Thanks for your help!

@yayannabelle
Copy link

Sure thing! I didn't wanna start writing down these note locations in the wrong and then have you guys be like "nah, that's not what we're after".

I can definitely do that, thanks for letting me know! 😄

@yayannabelle
Copy link

yayannabelle commented Oct 4, 2016

First chunk down! Here we go:
Line 560
Line 182, kinda (feels like the kind of thing worth mentioning, at least! If it does need a @todo, let me know and I'll add it in and do the pull request)
Line 88
Line 178
Line 116
Lines 56, 77, and 132
Line 22
Line 101 and 237
Line 6
Line 699 (and a similar comment to before on line 802, again I don't want to jump the gun and add an unnecessary @todo but it feels like it could use one!)
Line 46
Back later/tomorrow with more!
Edit: Whoops, missed a thing: I'm not entirely sure about this comment needing a @todo either, but it also stood out.

@benlk
Copy link
Collaborator Author

benlk commented Oct 5, 2016

I'd say that https://github.com/yayannabelle/Largo/blob/develop/inc/post-templates.php#L126 does deserve an @todo.

Thanks for the PR, and your work here. How would you like to be credited in the 0.5.5 release notes?

@yayannabelle
Copy link

No worries - still got a few more folders to get through, apologies for the delay! Annabelle W / @yayannabelle would be just fine, thanks!

@yayannabelle
Copy link

Second and last lot:
Line 440, 522, 2533
Lines 33 & 34
Line 397
Lines 121, 128, 154, 159, 165
Line 3099
Lines 158, 183, 1783-4, 2165, 2357, 3129, 3288, 3033 (I giggled but also don't do it!), 3332
Line 123, 155, 195
Line 97, 215
Line 40
Line 73
Line 81
Line 425, 450, 457
Line 147

Files I've added tentative "@todo ?"s to: first, second, third, and fourth.

And that's all the files checked! Time for a 2nd PR. Please let me know if there's anything else of this kind that needs doing in the future, I'd be more than happy to help!

@benlk benlk removed this from the Backlog milestone Apr 26, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good for beginners priority: low Nice-to-have in a release.
Projects
None yet
Development

No branches or pull requests

3 participants