kpi-web-guild / django-girls-blog-RootenberG

django-girls-blog-RootenberG created by GitHub Classroom
MIT License
0 stars 0 forks source link

Create basic configuration and info files #9

Closed RootenberG closed 5 years ago

RootenberG commented 5 years ago

Closes #6

webknjaz commented 5 years ago

Extend the commit message with a longer description explaining what it does more precisely.

RootenberG commented 5 years ago

Extend the commit message with a longer description explaining what it does more precisely.

But everyone can see the list of changes using the git log -p command, I think it is not difficult to understand what is happening.

webknjaz commented 5 years ago

People rarely look at patch contents before checking the commits list. The history should make sense to attract the reader to certain commit so that they'd look into it closer.

webknjaz commented 5 years ago

to simplify the work on the project

It sounds like an advertisement "hey, apply this cool commit", but you're not writing a novel.

This is too abstract. Be more pragmatic. Explain how this commit is useful on the high level.

It should add value. For obvious things like these configs controlling Git behavior you don't need to explain what they do — the reader already uses Git and they either already know what those files are or know where to find such info.

I'd do something like this:

Create initial git config files

Specify:
* .gitignore
* .gitatributes
webknjaz commented 5 years ago

Also, let's do #14 before merging this

webknjaz commented 5 years ago

Now squash related changes and let's wait for #14

webknjaz commented 5 years ago

Let's merge #12 first