Update CONTRIBUTING.md with pre-commit plugin instructions · Pull Request #3979 · TheAlgorithms/Python · GitHub
Skip to content

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

Merged
dhruvmanila merged 6 commits into
masterfrom
unknown repository
Nov 28, 2020
Merged

dhruvmanila merged 6 commits into
masterfrom
unknown repository

Conversation

@ghost

@ghost ghost commented Nov 28, 2020

Copy link
Copy Markdown

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

dhruvmanila commented Nov 28, 2020

Copy link
Copy Markdown
Member

Comment thread CONTRIBUTING.md Outdated
@dhruvmanila

Copy link
Copy Markdown
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
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
xcodz-dot and others added 2 commits November 28, 2020 19:01
Co-authored-by: Christian Clauss <cclauss@me.com>
Co-authored-by: Christian Clauss <cclauss@me.com>
@ghost
ghost requested review from cclauss and dhruvmanila November 28, 2020 13:31
@ghost ghost removed the awaiting reviews This PR is ready to be reviewed label Nov 28, 2020
@ghost
ghost 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
@ghost

ghost commented Nov 28, 2020

Copy link
Copy Markdown
Author

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

@dhruvmanila

Copy link
Copy Markdown
Member

@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
@ghost
ghost 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
…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
…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
…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
…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

Labels

documentation This PR modified documentation files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Guiding people using contibuting.md so they do not fail pre-commit

3 participants