Как опубликовать исходные файлы проекта Java на GIT?

Question

Я хочу начать перемещение некоторых моих проектов в репозитории github. Я немного перегружен тем, как организовать файлы в этих репозиториях. Я хочу, чтобы я сделал это правильно. Конкретный проект, над которым я работал, - это проект Java, который я создавал в Eclipse. По сути, это «двигатель», поэтому идеальным результатом было бы то, что люди клонировали репозиторий и строили на нем свой собственный проект, который использует движок.

Вот моя местная структура проекта.

src 
--com 
----myName 
------projectName 
test 
--com 
----myName 
------projectName 
bin 
config.properties 
README.md 
.gitignore 
.classpath 
.project 

Одна из первых вещей, которые я сделал, это gitignore все в папке bin и всех файлах классов.

Это не похоже на «правильный» способ делать вещи. Я просто догадываюсь. Существуют ли какие-либо стандартные соглашения, к которым я могу присоединиться?

позволяют также задать некоторые конкретные вопросы

1. это хорошо, что пакеты Явы создает много (по-видимому избыточных) подпапок?

2. Правильно ли игнорировать папку с bin? Или это осложнит проект, если кто-то другой будет клонировать его?

3. Я хочу сказать, что путь к классам и папке проекта также следует игнорировать, но они отражают изменения в файлах. Правильно ли я считаю, что это должны быть файлы, которые можно использовать?

4. Нужно ли делать какие-либо особые изменения в организации, чтобы отразить, как этот конкретный проект является «двигателем», который я намеревался клонировать и использовать в своих проектах?

Я чувствую, что это простая концепция, которую я могу усложнять, но я хочу убедиться, что это сделано правильно в первый раз. Любые ресурсы, которые каждый может указать мне на организацию git repo, будут оценены!

Заранее спасибо.

Answer 1

Для того, что мое понимание вещей, вы можете сделать две вещи:

Share свои источники как библиотеки Java, завернутые в файле JAR. Вы можете избежать всего этого, «как мне поделиться».

Или вы можете поделиться проектом в инструменте версии программного обеспечения, например, GIT. В идеале вам придется предоставить клиентам две вещи: код и способ легко настроить их среду для кодирования.

В вашем случае

Чтобы разделить код: Код находится под источником Java под Src и тесты папок.

Чтобы позволить другим лицам быстро настроить среду для работы: давайте посмотрим, что вы используете систему сборки, в которой используется Eclipse, поэтому вы должны изучить, как разделить проект затмения с машиной с другим. То, что я могу сказать вам заранее, это ... i, что папка bin не нужна (2). Но это путь .classpath и .project. Это необходимо для того, чтобы открыть проект в среде IDE Eclipse ... проблема в том, что ваша IDE, возможно, имеет определенную конфигурацию библиотеки или класса, которую нет в других Eclipse, и могут возникнуть проблемы (3).

Я рекомендую поделиться своим проектом с помощью независимого конструктора. Например, как maven. Да .. вы всегда зависите от чего-то .. это только вопрос о том, что проще, и человечество доказывает, что с такими вещами, как maven, это проще.

О вопросе (1), неплохо, поскольку он имеет смысл.

и (4) думаю нет.