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

Create initial pre-commit configuration #165

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

Conversation

stdedos
Copy link

@stdedos stdedos commented Apr 2, 2024

The commit introduces a basic pre-commit configuration
with hooks for auto-fixing common code quality issues:

  • Ensure files end with a newline (end-of-file-fixer),
  • Standardizing line endings to LF (mixed-line-ending), and
  • Removing trailing whitespace (trailing-whitespace).

To activate, developers should install pre-commit and pre-commit install.
By using the https://pre-commit.ci application, the repository can ensure compliance friction-free.

Signed-off-by: Stavros Ntentos 133706+stdedos@users.noreply.github.com

The commit introduces a basic `pre-commit` configuration
with hooks for auto-fixing common code quality issues:

* Ensure files end with a newline (`end-of-file-fixer`),
* Standardizing line endings to LF (`mixed-line-ending`), and
* Removing trailing whitespace (`trailing-whitespace`).

To activate, developers should install `pre-commit` and `pre-commit install`.
By using the https://pre-commit.ci application, the repository can ensure compliance friction-free.

Signed-off-by: Stavros Ntentos <133706+stdedos@users.noreply.github.com>
@stdedos
Copy link
Author

stdedos commented Apr 2, 2024

@isaak654 #111 (comment)

Here is my proposal. I hope upstream (i.e., you, in plural) is okay with installing the https://pre-commit.ci/ app.
There are other ways also, but less powerful.

Please familiarize yourself with the (short) website/demo/docs https://pre-commit.ci/.

It may be possible to see the results of my MR, after you install the pre-commit.ci in the repository, on this same MR.

@isaak654
Copy link
Collaborator

isaak654 commented Apr 4, 2024

Here is my proposal. I hope upstream (i.e., you, in plural) is okay with installing the https://pre-commit.ci/ app.

There are doubts in this regard:

xanatosdavid
well it says free for open source repositories so i guess we can install it for free
xanatosdavid
hmm... it says 0€ but still wants billing informations
xanatosdavid
woukd that tool help so much?

If you agree to include an email address in your GitHub profile, I can invite you on Slack to discuss with the repository owner.

@stdedos
Copy link
Author

stdedos commented Apr 7, 2024

@isaak654 I have tried reaching you in private on Discord

README.md Outdated
Comment on lines 44 to 46
Specifically, for this repo:
* Install `pre-commit` (`pip install pre-commit`; see more ways in https://pre-commit.com/#installation), and
* At the root of the repository, run `pre-commit install`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Specifically, for this repo:
* Install `pre-commit` (`pip install pre-commit`; see more ways in https://pre-commit.com/#installation), and
* At the root of the repository, run `pre-commit install`
Specifically, for this repository:
* Install `pre-commit` (`pip install pre-commit`; see more ways in https://pre-commit.com/#installation)
* At the root of the repository, run `pre-commit install`

README.md Show resolved Hide resolved
Signed-off-by: Stavros Ntentos <133706+stdedos@users.noreply.github.com>
@stdedos stdedos requested a review from isaak654 May 2, 2024 09:10
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.

None yet

2 participants