search

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

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

Add basic configuration and info files to the project #16

Closed OlenaYefymenko closed 1 year ago

OlenaYefymenko commented 1 year ago

This adds basic documentation for the project. It allows getting detailed information about the purpose of the project, implementation, contribution and license information.

Also, the patch integrates two configuration files. .gitignore excludes certain files and directories typical for Django projects. gitattributes provides instructions for declaring different file types and normalization the text files in the project.

Resolves #13

OlenaYefymenko commented 1 year ago

Don't include the commit that introduces this config file. Exclude it, so that only changes described in the PR title and description show up here.

As if it succeeded

webknjaz commented 1 year ago

Add README.md Add LICENSE.md

Try not to use the filenames in commit titles — this information is visible when one is viewing commits (just look at https://github.com/kpi-web-guild/django-girls-blog-OlenaEfymenko/commit/95b563c842bbc9c55b95e53d7a73b16d3702769d — below the commit message and metadata, it's absolutely obvious which file was added, same goes for terminal commands and code editors, they all know how to display this data). It is not more informative as if the commits were Add file1.txt, and then, Add file2.txt, followed by Edit file2.txt — this kind of titles is seemingly precise but provides zero useful context. Your job is to provide useful context from a human perspective, not duplicate machine-readable metadata that is always available. Use this chance to provide specific information about a higher-level effect of the commits and put longer description where it belongs. Add a project README sounds more precise since it is accurately refers a project root (as opposed as adding a readme file to various subdirectories, which is also possible). It could be followed by a long description saying This patch introduces generic README structure, providing intro, usage and license information.. For the commit adding the license, it could be Add an MIT license into the project. The longer part could explain the choice motivation.

Similar with gitignore. In the long description I'd refer that it's for Django, in particular.

.gitattributes provides instructions for processing the different file types into the project.

This seems generic. It's an educational phrase about Git, but it doesn't explain the purpose/motivation wrt to this project.

This could explain that what's added instructs Git to normalize text files to be treated as Unicode with UNIX-style EOL. Say that image, font, pdf files are declared binary. Though, I'm not sure about the export-ignore entries. I'd argue that said files should never make it into a Git repo in the first place, so ignoring them when making a Git archive out of the repo would have no effect. Instead, these need to be gitignored.

OlenaYefymenko commented 1 year ago

Thank you, I edited.

OlenaYefymenko commented 1 year ago

@webknjaz thank you, I updated PR description. Also, the unnecessary line was removed in README.

webknjaz commented 1 year ago

@OlenaYefymenko please, squash the related commits together so they do not end up being separate on the main branch.

OlenaYefymenko commented 1 year ago

@webknjaz squashing the commits was done.