Configuring git to handle `eol` #78

nariman87 · 2022-06-04T09:52:34Z

Context for changes

Improvements:
- Added .gitattributes to the repository, so git automatically handles consistent eol's for all commits and contributors across different operating systems.

Example usage and tests

Not Applicable

Performance results justifying changes

Not Applicable

Workflow actions and tests

Not Applicable

Expected benefits and drawbacks

Expected benefits:

git will configure the end of files to be UNIX-style for all commits even for Windows users for consistency reasons and based on .gitattributes inputs. Now, it will be much more likely for GitHub to track file changes.

Possible drawbacks:

We may get unexpected and undesired changes to some files in the repo and need to restore them. For Reviewers: please create a main-old and a local backup from the current main before merging this PR. We may need to restore all files or let .gitattributes start from an empty repo. More details here.

Related Github issues

Not Applicable

Checklist and integration statements

My Python and C++ codes follow this project's coding and commenting styles as indicated by existing files. Precisely, the changes conform to given black, docformatter and pylint configurations.
I have performed a self-review of these changes, checked my code (including for codefactor compliance), and corrected misspellings to the best of my capacity. I have synced this branch with others as required.
I have added context for corresponding changes in documentation and README.md as needed.
I have added new workflow CI tests for corresponding changes, ensuring codecoverage is 95% or better, and these pass locally for me.
I have updated CHANGELOG.md following the template. I recognize that the developers may revisit CHANGELOG.md and the versioning, and create a Special Release including my changes.

codecov · 2022-06-04T09:55:48Z

Codecov Report

Merging #78 (8bdd624) into main (ccbdcd8) will not change coverage.
The diff coverage is 96.63%.

@@           Coverage Diff           @@
##             main      #78   +/-   ##
=======================================
  Coverage   96.28%   96.28%           
=======================================
  Files          36       36           
  Lines        2233     2233           
=======================================
  Hits         2150     2150           
  Misses         83       83

Impacted Files	Coverage Δ
flamingpy/cv/ops.py	`91.57% <91.57%> (ø)`
flamingpy/cv/macro_reduce.py	`95.68% <95.68%> (ø)`
flamingpy/simulations.py	`96.80% <96.80%> (ø)`
flamingpy/decoders/unionfind/uf_classes.py	`99.08% <99.08%> (ø)`
flamingpy/decoders/unionfind/algos.py	`99.27% <99.27%> (ø)`
flamingpy/__init__.py	`100.00% <100.00%> (ø)`
flamingpy/_version.py	`100.00% <100.00%> (ø)`
flamingpy/decoders/mwpm/algos.py	`100.00% <100.00%> (ø)`
flamingpy/examples/decoding.py	`100.00% <100.00%> (ø)`
flamingpy/examples/surface_code.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ccbdcd8...8bdd624. Read the comment docs.

sduquemesa

Thanks @nariman87, this is great and can save devs some headaches in the long run! Let's hope it won't be to intrusive for the current devs.

sduquemesa · 2022-06-06T14:03:13Z

.github/CHANGELOG.md

@@ -20,7 +21,7 @@

 This release contains contributions from (in alphabetical order):

-[Joost Bus](https://github.com/soosub), [Sebastián Duque Mesa](https://github.com/sduquemesa), [Luis Mantilla](https://github.com/BestQuark)
+[Joost Bus](https://github.com/soosub), [Sebastián Duque Mesa](https://github.com/sduquemesa), [Luis Mantilla](https://github.com/BestQuark), Nariman Saadatmand


Don't forget to add your github handle 📲

Suggested change

[Joost Bus](https://github.com/soosub), [Sebastián Duque Mesa](https://github.com/sduquemesa), [Luis Mantilla](https://github.com/BestQuark), Nariman Saadatmand

[Joost Bus](https://github.com/soosub), [Sebastián Duque Mesa](https://github.com/sduquemesa), [Luis Mantilla](https://github.com/BestQuark), [Nariman Saadatmand](https://github.com/nariman87)

Let's avoid doing that for now, thanks.

ilan-tz

Thank for this @nariman87 ! The PR is meant to address some annoying "false positive" differences in files GitHub keeps finding. It has happened in a few PRs, but maybe #55 could be a good test case for the fix

Do you think these changes correct the behaviour we observe in examples/surface_code.py?

Also, after merging this PR, would we have to follow the instructions here (the section Refreshing a repository after changing line endings)?

nariman87 · 2022-06-06T23:53:50Z

Thank for this @nariman87 ! The PR is meant to address some annoying "false positive" differences in files GitHub keeps finding. It has happened in a few PRs, but maybe #55 could be a good test case for the fix

Do you think these changes correct the behaviour we observe in examples/surface_code.py?

Also, after merging this PR, would we have to follow the instructions here (the section Refreshing a repository after changing line endings)?

Not essentially, full refreshing may or may not be required, we need to see and must backup to main-old.

A better solution could be to make a super minor change to or delete problematic files and then commit them, so git automatically fix them. I may do some follow-up PRs.

I would say it quite possibly resolves the issue with that PR, but cannot be certain until we merge this and then make more changes as needed.

* Update _version.py * Update setup.py * Update README.md * Update dev_requirements.txt * Update DOCS.rst * Update test_graphstates.py * Update _version.py * Update __init__.py * Update gkp.py * Update matching.py * Update shortest_path.py * Update simulations.py * Update requirements.txt * Update dev_requirements.txt * Rename requirements.txt to dev_requirements.txt * Update Makefile * Update dev_requirements.txt * Update dev_requirements.txt * Update index.rst * Update index.rst * Update conf.py * Update index.rst * Update and rename index.rst to intro_page.rst * Added usage/ tree for docs ... * Rename getting_started to getting_started.rst * Update getting_started.rst * Create tutorials.rst * Create package_installation.rst * Update package_installation.rst * Update intro_page.rst * Update and rename development_guide.rst to guide_for_devs.rst * Delete doc/introduction directory * Update README.md * Update intro_page.rst * Added help/ tree for docs ... * Update and rename intro_page.rst to index.rst * Update index.rst * Rename package_installation.rst to easy_installation.rst * Update easy_installation.rst * Update guide_for_devs.rst * Update index.rst * Update index.rst * Update easy_installation.rst * Update guide_for_devs.rst * Update guide_for_devs.rst * Update guide_for_devs.rst * Update and rename install.html to installation_at_a_glance.html * Update installation_at_a_glance.html * Rename installation_at_a_glance.html to install.html * Create contribution.rst * Update index.rst * Update build_tests.yaml * Update format.yaml * Update linting.yaml * Update upload_linux_x64.yaml * Update upload_macos_x64.yaml * Update upload_win_x64.yaml * Update pull_request_template.md * Update README.md * Update macro_reduce.py * Update setup.py * Update build_tests.yaml * Update upload_linux_x64.yaml * Update upload_macos_x64.yaml * Update upload_win_x64.yaml * Running black ... * Update setup.py * Update setup.py * Update setup.py * Update setup.py * Update setup.py * Update dev_requirements.txt * Update dev_requirements.txt * Update dev_requirements.txt * Update setup.py * Update dev_requirements.txt * Update dev_requirements.txt * Update format.yaml * Update dev_requirements.txt * docformatting macro_reduce.py ... * Update upload_linux_x64.yaml * Update setup.py * Update setup.py * Update setup.py * Delete MANIFEST.in * Update setup.py * Update setup.py * Update setup.py * Update setup.py * Update setup.py * Update setup.py * Update setup.py * Update setup.py * Update setup.py * Update setup.py * Update setup.py * Create MANIFEST.in * Update MANIFEST.in * Update MANIFEST.in * Update setup.py * Update MANIFEST.in * Update lemonpy.cpp * Update _version.py * Update CODEOWNERS * Update upload_win_x64.yaml * Update _version.py * Update upload_win_x64.yaml * Update _version.py * Update Makefile * Update Makefile * Update Makefile * Update DOCS.rst * Update index.rst * Rename DOCS.rst to documentation.rst * Update Makefile * Moving and renaming DOCS.rst ... * Update and rename documentation.rst to build_docs.rst * Update index.rst * Update README.md Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com> * Update contribution.rst * Update README.md * Update doc/development/guide_for_devs.rst Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com> * Update doc/development/guide_for_devs.rst Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com> * Update upload_win_x64.yaml * Update _version.py * Update setup.py * Update upload_win_x64.yaml * Update setup.py * Update _version.py * Update setup.py * Update setup.py * Ugly workaround to make MANIFEST.in working with Windows * Update upload_linux_x64.yaml * Update upload_macos_x64.yaml * Update upload_win_x64.yaml * Update _version.py * Update upload_linux_x64.yaml * Update upload_macos_x64.yaml * Update upload_win_x64.yaml * Update doc/development/contribution.rst Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com> * Update README.md Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com> Co-authored-by: ilan-tz <57886357+ilan-tz@users.noreply.github.com>

Create .gitattributes

7efb773

nariman87 added chores Standard routines for open-source software projects programming conventions Provides better coding practices and align with standard formatting such as PEP labels Jun 4, 2022

nariman87 self-assigned this Jun 4, 2022

nariman87 requested review from ilan-tz and maxtremblay as code owners June 4, 2022 09:52

nariman87 added 2 commits June 4, 2022 19:56

Update CHANGELOG.md

28f5272

Update CHANGELOG.md

701fd02

sduquemesa approved these changes Jun 6, 2022

View reviewed changes

ilan-tz reviewed Jun 6, 2022

View reviewed changes

ilan-tz approved these changes Jun 7, 2022

View reviewed changes

nariman87 added 5 commits June 7, 2022 10:34

Update surface_code.py

0fba18a

auto eol changes

f977258

Merge remote-tracking branch 'origin/main' into auto-eol

6a3d1f6

Update _version.py

b6672e0

Some whitespace testing on surface_code.py

8bdd624

nariman87 merged commit 489d50b into main Jun 7, 2022

nariman87 deleted the auto-eol branch June 7, 2022 01:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Configuring git to handle `eol` #78

Configuring git to handle `eol` #78

nariman87 commented Jun 4, 2022 •

edited

Loading

codecov bot commented Jun 4, 2022 •

edited

Loading

sduquemesa left a comment

sduquemesa Jun 6, 2022

nariman87 Jun 6, 2022 •

edited

Loading

ilan-tz left a comment

nariman87 commented Jun 6, 2022 •

edited

Loading

	[Joost Bus](https://github.com/soosub), [Sebastián Duque Mesa](https://github.com/sduquemesa), [Luis Mantilla](https://github.com/BestQuark), Nariman Saadatmand
	[Joost Bus](https://github.com/soosub), [Sebastián Duque Mesa](https://github.com/sduquemesa), [Luis Mantilla](https://github.com/BestQuark), [Nariman Saadatmand](https://github.com/nariman87)

Configuring git to handle eol #78

Configuring git to handle eol #78

Conversation

nariman87 commented Jun 4, 2022 • edited Loading

Context for changes

Example usage and tests

Performance results justifying changes

Workflow actions and tests

Expected benefits and drawbacks

Related Github issues

Checklist and integration statements

codecov bot commented Jun 4, 2022 • edited Loading

Codecov Report

sduquemesa left a comment

Choose a reason for hiding this comment

sduquemesa Jun 6, 2022

Choose a reason for hiding this comment

nariman87 Jun 6, 2022 • edited Loading

Choose a reason for hiding this comment

ilan-tz left a comment

Choose a reason for hiding this comment

nariman87 commented Jun 6, 2022 • edited Loading

Configuring git to handle `eol` #78

Configuring git to handle `eol` #78

nariman87 commented Jun 4, 2022 •

edited

Loading

codecov bot commented Jun 4, 2022 •

edited

Loading

nariman87 Jun 6, 2022 •

edited

Loading

nariman87 commented Jun 6, 2022 •

edited

Loading