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.

Sign up for GitHub

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

Jump to bottom

Update CONTRIBUTING.md with pre-commit plugin instructions #3979

Merged
merged 6 commits into from
Nov 28, 2020
Merged

Update CONTRIBUTING.md with pre-commit plugin instructions #3979

merged 6 commits into from
Nov 28, 2020

Conversation

amaank404
Copy link
Contributor

Describe your change:

Added pre-commit instructions to contributing.md (Most PRs get their tests fail with pre-commit)

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.

fixes: #3887

@ghost ghost added the awaiting reviews This PR is ready to be reviewed label Nov 28, 2020
@dhruvmanila
Copy link
Member

dhruvmanila commented Nov 28, 2020 •
edited
Loading

I don't think this is the correct place to put this. This is a plugin you install and then forget about it. I would suggest putting a section similar to this or this right before the coding style part.

And the user doesn't need to run it with pre-commit run -a, they can but there's no need. Once the plugin is installed using pre-commit install, it will run automatically on every commit you make.

dhruvmanila
dhruvmanila reviewed Nov 28, 2020
View reviewed changes
@dhruvmanila
Copy link
Member

@cclauss @poyea Can you take a final look at the changes?

@dhruvmanila dhruvmanila changed the title Update CONTRIBUTING.md Update CONTRIBUTING.md with pre-commit plugin instructions Nov 28, 2020
@dhruvmanila dhruvmanila added the documentation This PR modified documentation files label Nov 28, 2020
cclauss
cclauss reviewed Nov 28, 2020
View reviewed changes
cclauss
cclauss reviewed Nov 28, 2020
View reviewed changes
amaank404 and others added 2 commits November 28, 2020 19:01
@amaank404 @cclauss
Update CONTRIBUTING.md
87c8351 
Co-authored-by: Christian Clauss <cclauss@me.com>
@amaank404 @cclauss
Update CONTRIBUTING.md
ad7e310 
Co-authored-by: Christian Clauss <cclauss@me.com>
@ghost ghost removed the awaiting reviews This PR is ready to be reviewed label Nov 28, 2020
@amaank404 amaank404 requested a review from poyea November 28, 2020 13:35
@ghost ghost added the tests are failing Do not merge until tests pass label Nov 28, 2020
@amaank404
Copy link
Contributor Author

@dhruvmanila I do not know why but the bot have labeled it as test failing

@dhruvmanila
Copy link
Member

It's because this commit failed: ad7e310

@ghost ghost added awaiting reviews This PR is ready to be reviewed and removed tests are failing Do not merge until tests pass labels Nov 28, 2020
@dhruvmanila dhruvmanila merged commit 8cafadd into TheAlgorithms:master Nov 28, 2020
@dhruvmanila dhruvmanila removed the awaiting reviews This PR is ready to be reviewed label Nov 28, 2020
@amaank404 amaank404 deleted the xcodz-dot-contributing-md branch November 28, 2020 13:40
stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
@amaank404 @dhruvmanila
@cclauss @stokhos
Update CONTRIBUTING.md with pre-commit plugin instructions (TheAlgori…
d557e3d 
…thms#3979)

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

Co-authored-by: Christian Clauss <cclauss@me.com>

* Update CONTRIBUTING.md

Co-authored-by: Christian Clauss <cclauss@me.com>

* Update CONTRIBUTING.md

Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
peRFectBeliever pushed a commit to peRFectBeliever/Python that referenced this pull request Apr 1, 2021
@amaank404 @dhruvmanila
@cclauss @peRFectBeliever
Update CONTRIBUTING.md with pre-commit plugin instructions (TheAlgori…
54882af 
…thms#3979)

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

Co-authored-by: Christian Clauss <cclauss@me.com>

* Update CONTRIBUTING.md

Co-authored-by: Christian Clauss <cclauss@me.com>

* Update CONTRIBUTING.md

Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
Panquesito7 pushed a commit to Panquesito7/Python that referenced this pull request May 13, 2021
@amaank404 @dhruvmanila @cclauss
Update CONTRIBUTING.md with pre-commit plugin instructions (TheAlgori…
a3f60c7 
…thms#3979)

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

Co-authored-by: Christian Clauss <cclauss@me.com>

* Update CONTRIBUTING.md

Co-authored-by: Christian Clauss <cclauss@me.com>

* Update CONTRIBUTING.md

Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
shermanhui pushed a commit to shermanhui/Python that referenced this pull request Oct 22, 2021
@amaank404 @dhruvmanila
@cclauss @shermanhui
Update CONTRIBUTING.md with pre-commit plugin instructions (TheAlgori…
d916844 
…thms#3979)

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

Co-authored-by: Christian Clauss <cclauss@me.com>

* Update CONTRIBUTING.md

Co-authored-by: Christian Clauss <cclauss@me.com>

* Update CONTRIBUTING.md

Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss Awaiting requested review from cclauss

@dhruvmanila dhruvmanila Awaiting requested review from dhruvmanila

@poyea poyea Awaiting requested review from poyea

Assignees
No one assigned
Labels
documentation This PR modified documentation files
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Guiding people using contibuting.md so they do not fail pre-commit
4 participants
@amaank404 @dhruvmanila @cclauss @poyea