LINUX.ORG.RU
Форум — Development  

Не понятное оформление кода. Где почитать?

 


0

2

src Fix sending messages with discussion December 5, 2022 17:04

tests Update ContactTest.php May 1, 2022 09:19

.editorconfig init June 26, 2015 16:15

.gitattributes init June 26, 2015 16:15

.gitignore Tests for User type + Refactoring June 29, 2015 22:30

.scrutinizer.yml final config fixes January 11, 2016 00:05

.travis.yml Added method sendDice and updated method sendPoll April 23, 2020 14:30

CHANGELOG.md

readme June 26, 2015 20:37

CONTRIBUTING.md moar replaces June 26, 2015 16:57

LICENSE.md replace mocks in project description June 26, 2015 16:56

README.md Update README.md October 30, 2020 20:03 composer.json Check ext-curl

======================

Какие то непонятные папки, файлы, тесты. А самого кода иногда - совсем мало.

Вижу это довольно таки часто. Что это за оформление? Зачем? И где про это можно почитать?

Спасибо

Перемещено hobbit из general



Последнее исправление: kompospec (всего исправлений: 5)
← bash-матрёшка из curl и jq
многомодульный проект в яве со спрингом и параметры при запуске. →

 ← 1 2 3
Ответ на: комментарий от kompospec

Это штука для коллективной работы над проектом. Программисты шлют свои куски кода в общий котел, главный принимает их в основную ветку, или в тестовую, или нет.

Irma ★★
()
Ответ на: комментарий от vbr

Это я понимаю. Но неужели автор писал каждый файл вручную?

Ведь это всё довольно общие вещи.

Лицензия - Мид.

.editorconfig - тут вообще написано, что отступ 4 пробела и всё.

И тд.

Может есть какой то генератор этого всего?

Почему код в SRC ?

Откуда это всё?

kompospec
() автор топика
Ответ на: комментарий от kompospec

Ну лицензию скорей всего скопипастил. gitignore многие тоже копипастят из шаблона. Остальные файлы - хз, может с другого проекта скопировал и адаптировал, может сам написал. В общем случае пишут сами.

Код в src от слова source. Когда такая куча всяких доп файлов, может быть удобно код держать в отдельной папке.

Про генератор всего я не слышал. Не думаю, что такой есть.

vbr ★★★★
()
Последнее исправление: vbr (всего исправлений: 1)
Ответ на: комментарий от kompospec

В каком месте это - ОФОРМЛЕНИЕ кода? Структура проекта тогда уж.

Часть файлов используется для управления ci/cd процессами, scrutinizer и travis. .editorconfig - https://habr.com/ru/articles/220131/. Исходники - в src, тесты - в tests

evgeny_aa ★★☆
()
Ответ на: комментарий от kompospec

Почитать про docker и docker-compose для начала, вникнуть в gitlab ci/cd и github actions. Отсюда уже должно появиться понимание, почему сейчас проекты выглядят так, как выглядят)

evgeny_aa ★★☆
()
  • src – это, понятное дело, исходники (их автор скорее всего скопирастил у другого автора)
  • tests – вообще нинужно (просто автор не может писать сразу исправный код, как и все жсовцы, скопипастил)
  • .editorconfig – конфиг какого-нибудь vscode, которые все годами таскают по проектам (скорее всего тоже скопипастил в основном)
  • .gitattributes, .gitignore – настройки гита, тоже все годами таскают от проекта к проекту потихоньку правя
  • .travis.yml – это для сборки проекта (вообще не нужно, но автор скопипастил, чтобы он типа шарит)
  • CHANGELOG.md – скорее всего заполнил сам по ходу написания кода
  • readme – не нужно
  • CONTRIBUTING.md – скопипастил из похожего проекта
  • LICENSE.md – тоже скопировал или выбрал при создании проекта в гитлабе
  • README.md – вероятно, написал сам, но структуру скопипастил

Короче, тут 95% скопировано из похожего проекта (в котором тоже основная масса кода скопирована), лишь бы было побольше файлов, чтобы проект выглядел как типа серьёзный, а не хелоуворлд детсадовца.

apt_install_lrzsz ★★★
()

Насколько я знаю, стандарта на структуру директорий в проекте не существует, но существуют бестпрактисы и гайдлайны, у каждого язычка и даже конкретного проекта свои.

Каталоги src и tests в корне часто можно увидеть в опенсорц проектах, наряду с lib, spec.

slowpony ★★★★★
()

Пока ты работаешь один, тебе это все не нужно.

Нужно становится тогда, когда приходишь в команду, но они тебе либо покажут тот «стандарт» о котором договорились между собой («работаем строго по PEP»).

slowpony ★★★★★
()

Опять же, тебе не нужна tests/ если у тебя в проекте нет тестов и ты не собираешься их писать. Тебе не нужна отдельная src если у тебя в проекте вообще нет ничего кроме сырцов, они тогда лягут сразу в корень. Ну и т.д.

slowpony ★★★★★
()
Ответ на: комментарий от apt_install_lrzsz

.travis.yml – это для сборки проекта (вообще не нужно, но автор скопипастил, чтобы он типа шарит)

Вообще, было нужно и очень полезно… пока гитхаб не придумал Github Actions. С которым у меня руки так и не дошли разобраться, так и болтается в корне репы поломанный .travis.yml :(

hobbit ★★★★★
()
 ← 1 2 3
← bash-матрёшка из curl и jq
Development
многомодульный проект в яве со спрингом и параметры при запуске. →