Как правильно называть папки в репозиториев github?

Question

[Daniel SERG]

Например я вижу что у многих есть одинаковые папки
src,dist,doc,test,build,.github
можно мне сказать что они все означают?
Я понимаю что это сделано для удобства
типо стандарта
но вот что куда кидать не понимаю)

PS:создаю маленький js движок для тега canvas;

Answer 1

[GavriKos]

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

Comments

[Daniel SERG]

а да,
ну например хочу создать 2D движок написан будет на javascript
под тег canvas чтобы было удобней пилить на ней игры)

[GavriKos]

Daniel SERG, тогда ориентируйтесь на репы с js.

[Daniel SERG]

GavriKos, А можно пожалуйста обьяснить что в этих папках хранят или их обозначение

src,dist,doc,test,build,.github

[GavriKos]

Daniel SERG, увы - js не моя область.
Но могу предположить:
- src - непосредственно исходный код
- dist - скомпилированный\собранный код в какой то пакет дл яраспространения. Или какие то файлы непосредственно для дистрибуции
- doc - внезапно - документация (наверняка в md формате)
- test - исходный код автотестов
- build - то же что и dist?
- .github - не папка. Читайте в мануале именно к гитхабу

Answer 2

[Владимир Красов]

Лучше всего называть папки, полностью и без сокращений на английском языке. Это в случае если вы делаете общий репозиторий. Если только для себя, то можно написать более простым языком с сокращениями... И да, стандарт зависит от того, для чего именно создан репозиторий, так что уточнить бы какой стандарт, и для чего...

Comments

[Daniel SERG]

поправил вопрос