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

Check files for UNIX-style line breaks and 644 permission #736

Merged
merged 10 commits into from
Dec 16, 2020

Conversation

seisman
Copy link
Member

@seisman seisman commented Dec 15, 2020

Description of proposed changes

Running dos2unix to all Python scripts and check if there are any files changed,
to make sure that we don't include any files with DOS-style line breaks.

The style checks fail due to #734. It also means that the line-break style check works as expected.

However, I can't use /format to automatically fix the line-break issue, as the
slash command dispatch read the workflow in the master branch only.

Address #734.

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Notes

  • You can write /format in the first line of a comment to lint the code automatically

Running `dos2unix` and check if there are any changes to make sure that
we don't include any files with DOS-style line breaks.
@seisman seisman added the maintenance Boring but important stuff for the core devs label Dec 15, 2020
@seisman seisman changed the title Check line break styles Check UNIX-style line break styles Dec 15, 2020
@seisman seisman changed the title Check UNIX-style line break styles Check UNIX-style line break Dec 15, 2020
@seisman seisman changed the title Check UNIX-style line break Check UNIX-style line breaks Dec 15, 2020
@seisman
Copy link
Member Author

seisman commented Dec 15, 2020

/format

@seisman seisman requested a review from a team December 15, 2020 16:04
@seisman seisman added this to the 0.3.0 milestone Dec 15, 2020
.github/workflows/ci_tests.yaml Outdated Show resolved Hide resolved
.github/workflows/ci_tests.yaml Show resolved Hide resolved
@weiji14
Copy link
Member

weiji14 commented Dec 15, 2020

I'll leave it up to you if you decide to implement the permissions (x, 755) check here or in a separate PR as discussed at #734 (comment).

Also, we should probably have a policy statement in CONTRIBUTING.md on the use of UNIX style line-endings and correct permissions (644) of files.

@seisman
Copy link
Member Author

seisman commented Dec 16, 2020

Also, we should probably have a policy statement in CONTRIBUTING.md on the use of UNIX style line-endings and correct permissions (644) of files.

I just added one sentence to address the policy.

@seisman seisman requested a review from weiji14 December 16, 2020 01:45
CONTRIBUTING.md Outdated Show resolved Hide resolved
@weiji14 weiji14 changed the title Check UNIX-style line breaks Check files for UNIX-style line breaks and 644 permission Dec 16, 2020
Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants