.classpath и .project - зарегистрироваться в управлении версиями или нет?
Я выполняю проект Java с открытым исходным кодом, который состоит из нескольких модулей в дереве зависимостей. Все те модули являются подкаталогами в репозитории подверсии. Для вновь прибывших к нашему проекту это - большая работа для установки всего этого вручную в затмении.
Не все наши разработчики используют затмение. Тем не менее, мы рассматриваем, чтобы просто зарегистрироваться в .classpath и .project файлах, чтобы помочь вновь прибывшим начать. Действительно ли это - хорошая идея? Или это привело бы к постоянным конфликтам в тех файлах? Существует ли альтернативный способ сделать проект легким настроить на затмении?
6 ответов
Определенно да, как я уже говорил в статье "Храните ли вы файлы проекта под контролем версий?"
"Загрузил, установил, пошел."
Но... это действительно верно только для последних версий Eclipse3. 5, где пути сборки поддерживают относительные пути:
И Eclipse3.6 был бы лучше, так как он поддерживает относительные пути для переменных путей в Linked Resources:
(начиная с 3.6M5)
Я бы проверил эти файлы, чтобы как можно проще начать работу с новыми пользователями. В лучшем случае пользователь должен проверить проект и иметь возможность запускать его без дополнительных знаний. Для этих файлов действуют те же правила, что и для других файлов в проекте: обращайтесь с ними осторожно. Вы не должны помещать абсолютные пути в исходный код, равно как и в файлы конфигурации.
Если файлы проверены таким образом, что проект запускается с нуля, не должно быть особых усилий для их изменения.
Я бы порекомендовал вам проверить файлы на Subversion, ЕСЛИ они не содержат абсолютных путей и других данных, которые могли бы напрямую связать их с единой средой разработчика.
Если файлы содержат абсолютные пути и т.п., README будет лучшим выбором.
Да, обязательно отметьте их, но убедитесь, что вы задокументировали все зависимости путей и по возможности избегаете абсолютных путей.
Если вы их не отметите, то любой, кто проверяет проект, должен будет воссоздать все эти настройки, что раздражает и потенциально может привести к ошибкам.
Некоторые сложные настройки могут быть лучше обработаны сценарием для создания этих файлов, но обычно лучше просто зарегистрировать их.
Я голосую против, но это потому, что я обычно генерирую эти файлы из maven
Определенно нет - это вообще ужасная идея распространять файлы проекта с помощью подрывной деятельности. Тем более, что кто-то может их каким-то странным образом модифицировать. Хорошая страница в документации по проекту - гораздо лучшая идея. В нашем проекте тоже много модулей и сложная настройка. Мы создали страницу слияния, описывающую, как начать работу с проектом в каждой популярной среде IDE - IntelliJ, Eclipse, NetBeans. Файл README в Subversion содержит ту же информацию.