GithubHelp home page GithubHelp logo

Comments (4)

letulip avatar letulip commented on June 29, 2024

GitIgnore есть, EditorConfig есть, только я не совсем понял что с ним делать.
Прошу пояснить по поводу файла README.md, с моей точки зрения текущее форматирование выглядит нормально.

from fixedthreadpool.

BekoBou avatar BekoBou commented on June 29, 2024

Представь, что человек первый раз читает документ README.md. Он вообще не понимает что это за проект, зачем? Банально оформить переменные или код как код, а не просто строку.

.gitignore обычно один на весь проект и лежит в корневой директории
.editorconfig содержит настройки редактора и так же лежит в корневой директории

from fixedthreadpool.

BekoBou avatar BekoBou commented on June 29, 2024

Кажется ты не понял, что такое editor config. Посмотри на эти страницы:

from fixedthreadpool.

BekoBou avatar BekoBou commented on June 29, 2024

Немного откорректированная запись о файле README.md. Поможет тебе лучше описать свой проект.

README.md — первое, что увидит пользователь, обращаясь к вашему репозиторию. В связи с этим, стоит обратить пристальное внимание на его наполнение.
Но что является первостепенным и как завладеть вниманием пользователя?

При ознакомлении с вашим проектом, пользователь должен знать:

  • что это;
  • насколько хорош код;
  • как его использовать;
  • что входит в проект;
  • как установить проект.

from fixedthreadpool.

Related Issues (3)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.