I will sometimes insert a TODO comment in my local branch. These notes are for things I want to do before submitting my code for review. A reviewer will never see them, and I never merge them into shared branches.
Other half-formed thoughts on comments
When I am forced to leave a comment, I use proper capitalization and punctuation. If I have to bring another comment into the world it might as well look nice.
One idea I've been toying with is writing method-level documentation comments. …
Comments containing TODO or FIXME
Fee: $ 500/line
I like the occasional TODO comment in my branch, but I never merge them in. FIXME is a "fuck you" to your coworkers.
Fee: $ 50/"wtf" from code reviewer
Try really, really, really hard to name things well. Update and improve your names constantly as the system changes. Be eager to rename something if you've found a better choice.
Static or class methods
Fee: $ 50/each
Class methods …
…the next several months on beefing up my testing suite. Also, lesson learned about resolving " TODO: This is stupid" when it would take 5 minutes to do rather than having it blow up in my face.
There, that's an experience I went through. Now you know the punchline, so hopefully you don't have to go through it as well.
Similarly, we can observe:
We need an updated list of all applications running on our servers, so that we know when a problem with a technology stack affects …
…are many gotchas surrounding sub-views for example that aren't typically mentioned in the many TODO list examples out there.
It is very easy to find yourself in a situation where your views are leaking memory if you aren't careful. Happily, with some recent additions to the framework and some good tools, we can identify these problems and patch them up.
Let's start with a model and a collection: class Item extends Backbone.Model
class Items extends Backbone.Collection …
Add a Run Script build phase to treat TODO and comments as warnings
These commands can be run individually as well. For example, setting the project's indentation level to 2 spaces can be done with liftoff indentation 2 .
The best part about using liftoff over another solution like a custom project template is that liftoff can be used to quickly add these settings to an existing project without worrying about stomping on your current setup.
liftoff is currently …
…a dedicated TODO section along the bottom of the main window. If you click on " TODO" it will show a listing of each file that has a TODO message inside of it and let you browse them.
I am not using AppCode as my full-time development environment, but it has proved to be an interesting utility to put in the toolbelt and to test legacy code bases against. There are a lot of interesting ideas in it that make me want to explore it even more in the coming weeks and months.
When the environment finishes launching and deploying the Todo application, visit it and check off/complete some tasks. Wait a minute and refresh. Shazzam! New tasks are magically created in the background (by delayed_job ).
Quirks of this approach
Running chef on deploy is a new idea, though doesn't fit in nicely yet with some aspects of Engine Yard Cloud. If you are ok with them, or their work arounds, then perhaps this is a great idea for us to productize more thoroughly.
…"todos" (instead of the actual model, which could be named TodoItem , Todo , or).
Notice that the differences here are similar to the changes made to a scenario relying heavily on' old web_steps.rb (taken from Aslak's post on the reasons for removing Cucumber Rails' training wheels ): Scenario: Successful login Given a user "Aslak" with password "xyz" And I am on the login page And I fill in "User …
…TODO comments when I know I need to change or fix something but don't want to do it yet. The TODO item may be a distraction at this time or something difficult that a future step will make easier. I find it easy to forget some necessary cleanup without them. We added a few when Elise would think of something she needed to change but I didn't want to get us distracted.
There was one other tip I had for Elise, as she was adding support for both Washington D.C. and the user's …
hi< rspecGroupMethods > trans< rspecGroupMethods > lo< Todo > FG:# d33682
These are the color highlight groups, in brackets. The leftmost one is the one with highest precedence, and the one we want to override.
3. Look at the list of available colors using :hi . Note the names of the groups on the left, and their displayed colors. Find one you like. The list will look something like this:
4. Create a link between the group you want to modify and the one you like. Let's …