Comments (4)
GitIgnore есть, EditorConfig есть, только я не совсем понял что с ним делать.
Прошу пояснить по поводу файла README.md, с моей точки зрения текущее форматирование выглядит нормально.
from fixedthreadpool.
Представь, что человек первый раз читает документ README.md
. Он вообще не понимает что это за проект, зачем? Банально оформить переменные или код как код, а не просто строку.
.gitignore обычно один на весь проект и лежит в корневой директории
.editorconfig содержит настройки редактора и так же лежит в корневой директории
from fixedthreadpool.
Кажется ты не понял, что такое editor config. Посмотри на эти страницы:
from fixedthreadpool.
Немного откорректированная запись о файле README.md
. Поможет тебе лучше описать свой проект.
README.md
— первое, что увидит пользователь, обращаясь к вашему репозиторию. В связи с этим, стоит обратить пристальное внимание на его наполнение.
Но что является первостепенным и как завладеть вниманием пользователя?При ознакомлении с вашим проектом, пользователь должен знать:
- что это;
- насколько хорош код;
- как его использовать;
- что входит в проект;
- как установить проект.
from fixedthreadpool.
Related Issues (3)
- Кто быстрее? HOT 1
- Семеро одного ждут! HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from fixedthreadpool.