Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure gitignore #51

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Restructure gitignore #51

wants to merge 4 commits into from

Conversation

pedrorrivero
Copy link
Member

Summary

Redesign sectioning format and order in .gitignore, and add new ignore (i.e. .venv/).

Details and comments

  • Major sections in all-caps
  • Subsections use multiple # symbols as in the .md format
  • Particular tools are referenced between [...], as in .cfg files

@coveralls
Copy link

coveralls commented Apr 18, 2022

Pull Request Test Coverage Report for Build 2184724951

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 2178142706: 0.0%
Covered Lines: 11
Relevant Lines: 11

💛 - Coveralls

@garrison
Copy link
Member

  • Major sections in all-caps

Is there a specific reason you prefer all caps? All caps are generally regarded as more difficult to read.

One thing that's nice about the current organization is that the lineage from GitHub's default python project .gitignore is apparent, and we can compare with the original as it changes over time. That said, the most important thing I care about with regards to this file is that it works for us.

@pedrorrivero
Copy link
Member Author

pedrorrivero commented Apr 25, 2022

@garrison

Is there a specific reason you prefer all caps? All caps are generally regarded as more difficult to read.

It is easier to tell sections apart, and distinguish form subsections. After all, we are not reading a whole paragraph in all-caps, but rather just a few words.

One thing that's nice about the current organization is that the lineage from GitHub's default python project .gitignore is apparent, and we can compare with the original as it changes over time.

I was not aware of this, but it might be important overtime. Maybe we should have one section paralleling that file, and labeled accordingly to avoid future confusion; and other sections to add our own ignores. That would work for me as well. Thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants