Skip to main content

New team member and code guidelines

Being a developer doesn’t mean that you are staying alone in a small room, in front of a computer and writing in a mystic programing language. Being a developer means working in a team, with real people, where you need to communicate and being part of a team. The code that is written by a developer will end to be modify by another developer from the same team or company. This means that is very important to write the code to respect the team and project standard.
But what should you do when one of guidelines are not part of your ‘believes’? For example adding a comment to each public class/interface or method.
There are developers that will NOT respect the guideline, will fight for it until the end of the world and will say NO – ‘I will never respect this guideline because is bullshit’.
This is an extremist approach and I think that this approach is not better than the one when you accept everything. In this cases the most important thing is communication. You need to understand why that guideline exist (it came from the team, architect, PM, company or client).
You should explain why the guideline is not good, but be aware, one time is not enough, because you may have people that use that guideline for 10-15 years and for them is a religion. Small steps are the best option in this cases.
But if none of the solutions works and all the team say that the guideline is good then you have two options:
Respect their decision, write code using their guideline (you didn’t lost the fight, but you need more mitigation – time is your best friend)
Leave the team and the project (the extremist developer : - ) )
The worst thing that you can do is to write code using your own guidelines. Even if you don’t like the guidelines, you should not ignore their guidelines. If you have 1 million lines of code written using a specific guideline, starting to write a part of the code with your own guidelines is a big mistake.
It is okay to write a small PoC where you can show them why that guideline is wrong, without making a push to the main repository.
In conclusion we could say that being a new member in a team can be hard, but you need to be a team player and accept other believes also.

Comments

  1. From my point of view, sometimes three lines of comment are not enough, but sometimes one line of comment is too much. There is no sense to set up a policy that requires comment for every public methods, because many methods can be trivial and described correctly by their name. On the other hand, if the method does something extraordinary, than more comments are required. If we set up a policy that every public method should be commented including the trivial ones, programmers will hate commenting, but the quality of the comments will be strange. I think, there is no sense to add a comment "Gets the users" to the method GetUsers, not to mention the trivial public properties. What is the intention of adding comment? Increasing the size of the code or adding extra data which can't be read out of the code?

    ReplyDelete
    Replies
    1. The comments rule was only an example for coding guideline.

      Delete

Post a Comment

Popular posts from this blog

How to audit an Azure Cosmos DB

In this post, we will talk about how we can audit an Azure Cosmos DB database. Before jumping into the problem let us define the business requirement: As an Administrator I want to be able to audit all changes that were done to specific collection inside my Azure Cosmos DB. The requirement is simple, but can be a little tricky to implement fully. First of all when you are using Azure Cosmos DB or any other storage solution there are 99% odds that you’ll have more than one system that writes data to it. This means that you have or not have control on the systems that are doing any create/update/delete operations. Solution 1: Diagnostic Logs Cosmos DB allows us activate diagnostics logs and stream the output a storage account for achieving to other systems like Event Hub or Log Analytics. This would allow us to have information related to who, when, what, response code and how the access operation to our Cosmos DB was done. Beside this there is a field that specifies what was th...

Can User Technical Profile Influence AI Architecture Decisions?

In the last few days, I ran a small experiment on Devin/Windsurf/Cascade, BMAD, and LLM-based architecture decisions. The initial concern was simple: if an AI coding assistant knows something about the user, for example, that the user is a Java developer or a .NET developer, can this information influence the architecture and technology stack that the AI will propose? This question is important because many companies are starting to use AI tools not only for coding but also for product discovery, architecture, documentation, and technical decision-making. If the AI is influenced by the developer's personal profile, the result may not be fully neutral. It may look like a business or architecture decision, but in reality, it may be partially shaped by the context of the person using the tool. The test was done using BMAD with Devin/Windsurf/Cascade. The scenario was a unified field service operations platform. The task was to let BMAD refine the product, define the architecture and s...

ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded

Today blog post will be started with the following error when running DB tests on the CI machine: threw exception: System.InvalidOperationException: The Entity Framework provider type 'System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer' registered in the application config file for the ADO.NET provider with invariant name 'System.Data.SqlClient' could not be loaded. Make sure that the assembly-qualified name is used and that the assembly is available to the running application. See http://go.microsoft.com/fwlink/?LinkId=260882 for more information. at System.Data.Entity.Infrastructure.DependencyResolution.ProviderServicesFactory.GetInstance(String providerTypeName, String providerInvariantName) This error happened only on the Continuous Integration machine. On the devs machines, everything has fine. The classic problem – on my machine it’s working. The CI has the following configuration: TeamCity .NET 4.51 EF 6.0.2 VS2013 It see...