Я хотел знать, можно ли считать, что мой подход к исходным файлам, которые необходимо удалить из системы контроля версий, считается плохой практикой.
Я хочу объяснить это вам на основе этого примера:
Недавно я очень разозлился, потому что мне пришлось утомительно разбирать классы Java в программе, которая была в основном мертвым кодом, однако это нигде не было документировано и также не комментировалось в этих классах Java. Конечно, их нужно было удалить, но перед тем, как я удалил такие лишние вещи, у меня есть - некоторые могут сказать странное - привычка:
Я не удаляю такие избыточные файлы сразу через SVN-> Delete (замените их командой delete из выбранной вами системы контроля версий), но вместо этого помещаю комментарии в эти файлы (я имею в виду как в верхнем, так и в нижнем колонтитуле), которые они собираются быть удаленным + мое имя + дата, а также - что более важно - ПОЧЕМУ ОНИ УДАЛЕНЫ (в моем случае, потому что они были мертвы, запутанный код). Затем я сохраняю и фиксирую их для контроля версий. В следующий раз, когда мне нужно зафиксировать / зарегистрировать что-либо в проекте для контроля версий, я нажимаю SVN-> Удалить, а затем они в конечном итоге удаляются в Версионном контроле - все еще, конечно, восстанавливаемым посредством ревизий, и именно поэтому я принял эту привычку.
Зачем делать это, а не удалять их сразу?
Моя причина в том, что я хочу иметь явные маркеры, по крайней мере, в последней ревизии, в которой существовали эти избыточные файлы, поэтому они заслуживают удаления. Если я удалю их сразу, они будут удалены, но нигде не задокументировано, почему они были удалены. Я хочу избежать типичного сценария, подобного этому:
«Хм… почему эти файлы были удалены? Я раньше работал нормально». (Прессы 'revert' -> парень, который вернулся, исчез навсегда или не будет доступен в течение следующих недель, и следующий сотрудник должен утомительно, как и я, выяснить, о чем эти файлы)
Но разве вы не замечаете, почему эти файлы были удалены в сообщениях о коммите?
Конечно, я делаю, но сообщение о коммите иногда не читается коллегами. Это не типичная ситуация, когда вы пытаетесь понять (в моем случае мертвый) код, что вы сначала проверяете журнал контроля версий со всеми связанными сообщениями фиксации. Вместо того, чтобы просматривать журнал, коллега сразу же видит, что этот файл бесполезен. Это экономит ее / его время, и она / он знает, что этот файл, вероятно, был восстановлен плохо (или, по крайней мере, это поднимает вопрос.