Questions tagged [maintainability]
system quality aspect characterizing the ease of software maintenance
144 questions
4 votes
1 answer
1k views
CA-1822: Mark members as static Roslyn recommendation will not unnecessarily increase memory consumption?
My job uses SonarQube as part of the CI/CD quality gate. One of the "Maintainability" issues (severity: medium) raised is the CA-1822: Mark members as static. The link explains the added ...
- 541
-1 votes
2 answers
224 views
Best thing to do by private developers in case of impending death or plans to cease development on a personal private project
Suppose I have a personal private code project. What should the developer do with the code in case of impending death or plans to cease development on their personal private project. Suppose, they do ...
2 votes
2 answers
425 views
In unit testing: How to abstract a dependency of subject under test?
Disclaimer: I am learning unit testing. I am also kind of beginner in object-oriented design. Currently, I am involved in the development of an application to manage the finance of a humble food ...
- 129
7 votes
6 answers
565 views
Is there a software quality metric related to side effects?
In large systems there are often code paths that modify state or produce side effects that other code comes to depend on. This makes it hard to safely change code without understanding the whole ...
- 471
2 votes
2 answers
477 views
Game Systems Interaction Design
Intro I'm writing an FPS game in c++. There is a timed game mode, players run around a map shoot from a variety of weapons which are either hitscan or projectile based, when a shot connects, based on ...
- 161
2 votes
1 answer
253 views
How to increase maintainability in CI/CD pipelines
We have an issue of maintainability for our pipelines at the organization where I work, whereby making a change and ensuring the change is tested and bug-free for our customers (other developers in ...
1 vote
3 answers
644 views
Java design approach for "duplicated" class that are identical, except the import sources are different
So I have two identical classes, say ClassA and ClassB. In both classes, they operate on the same kind of data classes, and the method bodies are exactly the same. The only difference is that the ...
- 25
3 votes
3 answers
571 views
Is there an approach to keep a large number of conditionals maintainable
I work on a survey that has a lot of questions. This means we have a lot of columns/variables to work with. This translates to a lot of conditionals that have to be done a certain way according to a ...
0 votes
3 answers
787 views
How to deal with an actively developed 20 year old legacy codebase [duplicate]
I know there are potential duplicates, but imo this is different because there are around 100 developers actively working on this nightmare. I have unfortunately gotten into a job where this GUI ...
- 55
1 vote
2 answers
405 views
Maintainably converting flowchart ideas to an architecture
My team is communicating proposals for the interaction of several processes as a flowchart. I've been drafting a codebase architecture we can use as a starting point. There are two ways intended ...
- 335
27 votes
5 answers
8k views
Dry running a function
I have a function with a sensitive operation: function doSomeThingSensitive() { customers = getAllCustomers() for each customer in customers if customer is from Europe Give ...
- 1,159
1 vote
4 answers
244 views
When should a method depend on a data source and NOT have it declared as a parameter?
I was assigned a code review to one of my colleagues. I posed the following, which I wanted to share here in order to hear whether I am right or wrong. Consider the following code snippet: public void ...
- 541
0 votes
2 answers
1k views
Architecting project into multiple source control repositories
I'm doing some work with my team to refactor/rearchitect some parts of our existing codebase which consists of two separate Django apps hosted in one common project repository. We're starting work on ...
- 213
8 votes
4 answers
3k views
Use local or nested function for readability?
I found in the catalog of Refactoring by Martin Fowler, with Kent Beck book that they mention Extract Function refactoring. It is a good practice to wrap your related code into local functions to ...
- 189
2 votes
3 answers
2k views
Best practices for maintainable Graphviz / PlantUML code
I've been using Graphviz a little and just found out about PlantUML which is quite similar. I make diagrams but later the processes or systems depicted by the diagrams might change so I need to make ...
- 509