Я работал соло над проектом в течение некоторого времени, и теперь, новые разработчики, вероятно, присоединятся к проекту по различным причинам.
Я, конечно, использую программное обеспечение управления версиями, но я - испуганный импорт моего проекта в Eclipse, и то, чтобы заставлять это работать могло бы оказаться немного трудным для новых посетителей, и я хочу сделать его максимально чистым.
Когда я сначала принял проект, мне потребовались почти два дня, чтобы создать проект и выполнить его, я зарегистрировал каждый шаг и зафиксировал самые очевидные ошибки, но не все, и я хочу проект работать, как это - при импорте.
Вот некоторые определенные проблемы, которые я имею прямо сейчас, я должен зафиксировать их, и как?
Для (4) я должен буду, вероятно, использовать знатока, но действительно ли возможно решить проблему (1) (2) и (3), не используя знатока?
Альтернатива должна иметь настроенный документ инструкции на одну страницу
Также сделайте у Вас есть любые другие общие или определенные советы относительно того, как организуют эту целую путаницу.
Спасибо
Управление зависимостями является обязательным - используйте Maven . Если вы не можете использовать maven, потому что вы уже используете ant, используйте Ivy .
Сделайте проект собираемым одним щелчком мыши - введите int ant build all
или mvn package
. Maven обеспечивает интеграцию с IDE (через плагин).
Не отвечать на метаданные IDE. например .project
и .classpath
. Вы все равно можете зафиксировать их, чтобы облегчить пользователям Eclipse, но не ограничивайте IDE.
Обеспечьте построение при сохранении. Либо с помощью Eclipse WTP, либо с помощью плагина FilSync (звучит как взлом, но довольно круто)
Используйте профили сборки (maven предоставляет их автоматически) - для создания разных сборок для разных сред
Не всегда возможно настроить все в своих сценариях maven (или ant / ivy). Для любых дополнительных действий, таких как установка сервера приложений - затем документируйте в одном файле в корне вашего проекта, описывая шаг за шагом, что нужно установить, с какими параметрами конфигурации и т. Д. Таким образом, у разработчиков есть только одно место, на которое можно смотреть и следить. Документ может (и лучше) быть простым.txt
Примечание: используйте непрерывную интеграцию - загрузите Hudson или TeamCity и настройте его для создания проекта
. Из моего недавнего опыта - у нас был проект, который мы работаю 6 месяцев. Моему коллеге пришлось повторно импортировать проект на новой машине. На это у него ушло 20 минут. Проект настроен с помощью Maven.