Skip to main content

Don't be a fiend, commit often.

You must know this pain. 

 

hg commit -Am "Massive commit of whole days work"

hg push

TIME FOR MERGING HELL! PREPARE YOUR ANUS!

 

As a comparison, merging tool we use Beyond Compare. Indeed it's not a bad tool. But it's not clairvoyant. No tool can completely remove headaches that are generated from both the above message and also rolling back from changes that have been commited. 

As mentioned, one of the boons of source control is the rolling back of changes if needed. I think this can be made difficult when you are checking in a ton of work at once from all sorts of little fixes, changes, tweaks and implemented functionality. 

My dream is to commit work discretely by feature. For example in CRUD land. You would discretely check in the create mechanism, view mechanism and so on. If you see small bugs elsewhere, write them down. Fix them in their own seperate commit afterwards (or before depending on the situation). 

I like breaking work down into features (what some people like to call requirements) that can then be tested, implemented and commited discretely. You can then have commit messages like; 

 

hg commit -Am "As an admin user you can now add customers to a business account"

 

When looking at the repository you can then see a nice development of features and how / when they were implemented. 

I'm not saying I do this all the time. It's what I aspire to do. I can still be a fiend to not commiting discretely and also nipping little bits and bobs in. But the more you try to do this, the better your life will be. 

Comments

Dom Finn said…
Yeah the csproj can be a real pain but just in general, the more you have to manually merge the greater the chance is of a cock up. I just feel a cold sweat every time Beyond Compare reveals it's ugly head.

Popular posts from this blog

Creating star ratings in HTML and Javascript

I'd searched around a little for some shortcuts to help in doing this but I couldn't find anything satisfactory that included the ability to pull the rating off again for saving. I'd ended up coming up with this rather cheeky solution. Hopefully it helps you too! This is my first post in a while (I stopped blogging properly about 8 years ago!) It's strange coming back to it. Blogger feels very crusty and old by todays standards too.

Make your objects immutable by default

More about the Good Dojo In my post last week , I discussed creating objects that are instantiated safely. Please go back and read if you are interested. At the end of the post, I mentioned that I'd also written the class so it was immutable when instantiated. This is important!!! I feel like a broken record in repeating this but I am sure at the time of writing your code, you aren't modifying your object all over the place and so are safe in the belief that protecting against mutability is overkill. Please remember though, your code could be around for a hell of a long time. You aren't writing your code for now... you are writing for the next fool that comes along (including you) . Nothing is more upsetting that coming back to fix a bug on some wonderfully crafted code to say "Who has butchered my code?!", but often you were involved at the start of the process. You made the code easy to modify, allowing objects to be used / reused / modified without thi

An instantiated object should be "ok"

I've been QA'ing quite a bit of work recently and one common theme I've noticed across both Java and C# projects I have been looking at is that we occasionally open ourselves up unessacarily to Exceptions by the way objects are being created. My general rule of thumb (which I have seen mentioned in a Pluralsight video recently but also always re-iterate in various Robust Software talks I have done) is that you shouldn't be able to create an object and then call a method or access a property that then throws an exception. At worst, it should return null (I'm not going to moan about that now). I've created an example below. We have two Dojos, one is good and one is bad. The bad dojo looks very familiar though. It's a little class written in the style that seems often encouraged. In fact, many classes start life as something like this. Then as years go on, you and other colleagues add more features to the class and it's instantiation becomes a second