Skip to content

Update developer toolset instructions in CONTRIBUTING.md - #7762

Closed
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Closed

Update developer toolset instructions in CONTRIBUTING.md#7762
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING

Conversation

@Cjkjvfnby

@CjkjvfnbyCjkjvfnby commented Oct 27, 2022

Copy link
Copy Markdown
Contributor

Replace/remove instructions on individual tools usage with pre-commit.
Instruction with flake8 is a bit misleading since the project uses flake8 plugins that should be installed to get the same linting as done by CI on each PR.

Also, add a few line breaks. It doe not affect rendered page and fits into the screen in the editor.

  • 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}.

@algorithms-keeperalgorithms-keeperBot added documentation This PR modified documentation files awaiting reviews This PR is ready to be reviewed labels Oct 27, 2022
@algorithms-keeperalgorithms-keeperBot mentioned this pull request Oct 27, 2022
Closed
14 tasks
cclauss
cclauss requested changes Oct 29, 2022
View reviewed changes
Comment threadCONTRIBUTING.md Outdated
@algorithms-keeperalgorithms-keeperBot added awaiting changes A maintainer has requested changes to this PR and removed awaiting reviews This PR is ready to be reviewed labels Oct 29, 2022
@cclausscclauss added ON HOLD: Final hours of Hacktoberfest We will review this PR after Hacktoberfest has ended and removed ON HOLD: Final hours of Hacktoberfest We will review this PR after Hacktoberfest has ended labels Oct 29, 2022
@Cjkjvfnby
Cjkjvfnbyforce-pushed the remove-flake8-mention-from-CONTRIBUTING branch from 1a86be3 to 1e07427CompareNovember 5, 2022 22:25
@algorithms-keeperalgorithms-keeperBot added awaiting reviews This PR is ready to be reviewed and removed awaiting changes A maintainer has requested changes to this PR labels Nov 5, 2022
@Cjkjvfnby
Cjkjvfnby requested a review from cclaussMarch 13, 2023 22:54
cclauss
cclauss reviewed Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md Outdated
cclauss
cclauss reviewed Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md Outdated
CaedenPH
CaedenPH requested changes Mar 17, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Comment on lines +84 to +90
- Please consider running [__psf/black__](https://github.com/python/black) on your Python file(s) before submitting your pull request. This is not yet a requirement but it does make your code more readable and automatically aligns it with much of [PEP 8](https://www.python.org/dev/peps/pep-0008/). There are other code formatters (autopep8, yapf) but the __black__ formatter is now hosted by the Python Software Foundation. To use it,

```bash
python3 -m pip install black # only required the first time
black .
```

@CaedenPHCaedenPHMar 17, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

In my opinion, this part isn't necessary because when you create the pr the pre-commit bot automatically formats it because it's in the pre-commit

@cclauss

cclauss commented Mar 17, 2023

Copy link
Copy Markdown
Member

I do not see the value of these changes.
Some contributors will install pre-commit but the majority will not so…

  • Black corrections will be made automatically so let’s not require it to be installed.
  • The same will be true of Ruff fixes in the future.
  • it is OK to discuss mypy as is currently done because it does not ”fix” code so having it installed locally might be helpful to some contributors.
  • Command line tools like Black, mypy, and ruff should be installed with pipx, not pip.

@Cjkjvfnby
Cjkjvfnby deleted the remove-flake8-mention-from-CONTRIBUTING branch March 17, 2023 23:06
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cclausscclausscclauss requested changes
@CaedenPHCaedenPHCaedenPH requested changes

Assignees

No one assigned

Labels

awaiting reviewsThis PR is ready to be revieweddocumentationThis PR modified documentation files

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Cjkjvfnby@cclauss@CaedenPH
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Update developer toolset instructions in CONTRIBUTING.md by Cjkjvfnby · Pull Request #7762 · TheAlgorithms/Python · GitHub
Skip to content
Update developer toolset instructions in CONTRIBUTING.md - #7762
Closed
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Closed
Update developer toolset instructions in CONTRIBUTING.md#7762
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Conversation
@Cjkjvfnby
@CjkjvfnbyCjkjvfnby
commented
Oct 27, 2022

Copy link


Copy Markdown

Contributor
Replace/remove instructions on individual tools usage with pre-commit.

Instruction with flake8 is a bit misleading since the project uses flake8 plugins that should be installed to get the same linting as done by CI on each PR.
Also, add a few line breaks. It doe not affect rendered page and fits into the screen in the editor.
  •  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}.
@algorithms-keeperalgorithms-keeperBot
added

documentation
This PR modified documentation files
awaiting reviews
This PR is ready to be reviewed
labels
Oct 27, 2022
@algorithms-keeperalgorithms-keeperBot
mentioned this pull request
Oct 27, 2022
 Closed

14 tasks
cclauss
cclauss
requested changes
Oct 29, 2022
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

@algorithms-keeperalgorithms-keeperBot
added

awaiting changes
A maintainer has requested changes to this PR
and removed

awaiting reviews
This PR is ready to be reviewed
labels
Oct 29, 2022
@cclausscclauss
added

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
and removed

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
labels
Oct 29, 2022
@Cjkjvfnby
Cjkjvfnbyforce-pushed
the
remove-flake8-mention-from-CONTRIBUTING
branch
from
1a86be3 to
1e07427CompareNovember 5, 2022 22:25
@algorithms-keeperalgorithms-keeperBot
added

awaiting reviews
This PR is ready to be reviewed
and removed

awaiting changes
A maintainer has requested changes to this PR
labels
Nov 5, 2022
@Cjkjvfnby
Cjkjvfnby
requested a review
from cclaussMarch 13, 2023 22:54
cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

CaedenPH
CaedenPH
requested changes
Mar 17, 2023
View reviewed changes
Comment threadCONTRIBUTING.md

Comment on lines

+84
 to 
+90

- Please consider running [__psf/black__](https://github.com/python/black) on your Python file(s) before submitting your pull request. This is not yet a requirement but it does make your code more readable and automatically aligns it with much of [PEP 8](https://www.python.org/dev/peps/pep-0008/). There are other code formatters (autopep8, yapf) but the __black__ formatter is now hosted by the Python Software Foundation. To use it,

 ```bash
 python3 -m pip install black # only required the first time
 black .
 ```

@CaedenPHCaedenPHMar 17, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

In my opinion, this part isn't necessary because when you create the pr the pre-commit bot automatically formats it because it's in the pre-commit
@cclauss
cclauss
commented
Mar 17, 2023

Copy link


Copy Markdown

Member
I do not see the value of these changes.

Some contributors will install pre-commit but the majority will not so…
  • Black corrections will be made automatically so let’s not require it to be installed.
  • The same will be true of Ruff fixes in the future.
  • it is OK to discuss mypy as is currently done because it does not ”fix” code so having it installed locally might be helpful to some contributors.
  • Command line tools like Black, mypy, and ruff should be installed with pipx, not pip.
@Cjkjvfnby
Cjkjvfnby
deleted the

remove-flake8-mention-from-CONTRIBUTING

branch
March 17, 2023 23:06
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cclausscclausscclauss requested changes
@CaedenPHCaedenPHCaedenPH requested changes

Assignees


No one assigned


Labels

awaiting reviewsThis PR is ready to be revieweddocumentationThis PR modified documentation files

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@Cjkjvfnby@cclauss@CaedenPH

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Update developer toolset instructions in CONTRIBUTING.md by Cjkjvfnby · Pull Request #7762 · TheAlgorithms/Python · GitHub
Skip to content
Update developer toolset instructions in CONTRIBUTING.md - #7762
Closed
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Closed
Update developer toolset instructions in CONTRIBUTING.md#7762
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Conversation
@Cjkjvfnby
@CjkjvfnbyCjkjvfnby
commented
Oct 27, 2022

Copy link


Copy Markdown

Contributor
Replace/remove instructions on individual tools usage with pre-commit.

Instruction with flake8 is a bit misleading since the project uses flake8 plugins that should be installed to get the same linting as done by CI on each PR.
Also, add a few line breaks. It doe not affect rendered page and fits into the screen in the editor.
  •  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}.
@algorithms-keeperalgorithms-keeperBot
added

documentation
This PR modified documentation files
awaiting reviews
This PR is ready to be reviewed
labels
Oct 27, 2022
@algorithms-keeperalgorithms-keeperBot
mentioned this pull request
Oct 27, 2022
 Closed

14 tasks
cclauss
cclauss
requested changes
Oct 29, 2022
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

@algorithms-keeperalgorithms-keeperBot
added

awaiting changes
A maintainer has requested changes to this PR
and removed

awaiting reviews
This PR is ready to be reviewed
labels
Oct 29, 2022
@cclausscclauss
added

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
and removed

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
labels
Oct 29, 2022
@Cjkjvfnby
Cjkjvfnbyforce-pushed
the
remove-flake8-mention-from-CONTRIBUTING
branch
from
1a86be3 to
1e07427CompareNovember 5, 2022 22:25
@algorithms-keeperalgorithms-keeperBot
added

awaiting reviews
This PR is ready to be reviewed
and removed

awaiting changes
A maintainer has requested changes to this PR
labels
Nov 5, 2022
@Cjkjvfnby
Cjkjvfnby
requested a review
from cclaussMarch 13, 2023 22:54
cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

CaedenPH
CaedenPH
requested changes
Mar 17, 2023
View reviewed changes
Comment threadCONTRIBUTING.md

Comment on lines

+84
 to 
+90

- Please consider running [__psf/black__](https://github.com/python/black) on your Python file(s) before submitting your pull request. This is not yet a requirement but it does make your code more readable and automatically aligns it with much of [PEP 8](https://www.python.org/dev/peps/pep-0008/). There are other code formatters (autopep8, yapf) but the __black__ formatter is now hosted by the Python Software Foundation. To use it,

 ```bash
 python3 -m pip install black # only required the first time
 black .
 ```

@CaedenPHCaedenPHMar 17, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

In my opinion, this part isn't necessary because when you create the pr the pre-commit bot automatically formats it because it's in the pre-commit
@cclauss
cclauss
commented
Mar 17, 2023

Copy link


Copy Markdown

Member
I do not see the value of these changes.

Some contributors will install pre-commit but the majority will not so…
  • Black corrections will be made automatically so let’s not require it to be installed.
  • The same will be true of Ruff fixes in the future.
  • it is OK to discuss mypy as is currently done because it does not ”fix” code so having it installed locally might be helpful to some contributors.
  • Command line tools like Black, mypy, and ruff should be installed with pipx, not pip.
@Cjkjvfnby
Cjkjvfnby
deleted the

remove-flake8-mention-from-CONTRIBUTING

branch
March 17, 2023 23:06
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cclausscclausscclauss requested changes
@CaedenPHCaedenPHCaedenPH requested changes

Assignees


No one assigned


Labels

awaiting reviewsThis PR is ready to be revieweddocumentationThis PR modified documentation files

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@Cjkjvfnby@cclauss@CaedenPH

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Update developer toolset instructions in CONTRIBUTING.md by Cjkjvfnby · Pull Request #7762 · TheAlgorithms/Python · GitHub
Skip to content
Update developer toolset instructions in CONTRIBUTING.md - #7762
Closed
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Closed
Update developer toolset instructions in CONTRIBUTING.md#7762
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Conversation
@Cjkjvfnby
@CjkjvfnbyCjkjvfnby
commented
Oct 27, 2022

Copy link


Copy Markdown

Contributor
Replace/remove instructions on individual tools usage with pre-commit.

Instruction with flake8 is a bit misleading since the project uses flake8 plugins that should be installed to get the same linting as done by CI on each PR.
Also, add a few line breaks. It doe not affect rendered page and fits into the screen in the editor.
  •  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}.
@algorithms-keeperalgorithms-keeperBot
added

documentation
This PR modified documentation files
awaiting reviews
This PR is ready to be reviewed
labels
Oct 27, 2022
@algorithms-keeperalgorithms-keeperBot
mentioned this pull request
Oct 27, 2022
 Closed

14 tasks
cclauss
cclauss
requested changes
Oct 29, 2022
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

@algorithms-keeperalgorithms-keeperBot
added

awaiting changes
A maintainer has requested changes to this PR
and removed

awaiting reviews
This PR is ready to be reviewed
labels
Oct 29, 2022
@cclausscclauss
added

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
and removed

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
labels
Oct 29, 2022
@Cjkjvfnby
Cjkjvfnbyforce-pushed
the
remove-flake8-mention-from-CONTRIBUTING
branch
from
1a86be3 to
1e07427CompareNovember 5, 2022 22:25
@algorithms-keeperalgorithms-keeperBot
added

awaiting reviews
This PR is ready to be reviewed
and removed

awaiting changes
A maintainer has requested changes to this PR
labels
Nov 5, 2022
@Cjkjvfnby
Cjkjvfnby
requested a review
from cclaussMarch 13, 2023 22:54
cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

CaedenPH
CaedenPH
requested changes
Mar 17, 2023
View reviewed changes
Comment threadCONTRIBUTING.md

Comment on lines

+84
 to 
+90

- Please consider running [__psf/black__](https://github.com/python/black) on your Python file(s) before submitting your pull request. This is not yet a requirement but it does make your code more readable and automatically aligns it with much of [PEP 8](https://www.python.org/dev/peps/pep-0008/). There are other code formatters (autopep8, yapf) but the __black__ formatter is now hosted by the Python Software Foundation. To use it,

 ```bash
 python3 -m pip install black # only required the first time
 black .
 ```

@CaedenPHCaedenPHMar 17, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

In my opinion, this part isn't necessary because when you create the pr the pre-commit bot automatically formats it because it's in the pre-commit
@cclauss
cclauss
commented
Mar 17, 2023

Copy link


Copy Markdown

Member
I do not see the value of these changes.

Some contributors will install pre-commit but the majority will not so…
  • Black corrections will be made automatically so let’s not require it to be installed.
  • The same will be true of Ruff fixes in the future.
  • it is OK to discuss mypy as is currently done because it does not ”fix” code so having it installed locally might be helpful to some contributors.
  • Command line tools like Black, mypy, and ruff should be installed with pipx, not pip.
@Cjkjvfnby
Cjkjvfnby
deleted the

remove-flake8-mention-from-CONTRIBUTING

branch
March 17, 2023 23:06
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cclausscclausscclauss requested changes
@CaedenPHCaedenPHCaedenPH requested changes

Assignees


No one assigned


Labels

awaiting reviewsThis PR is ready to be revieweddocumentationThis PR modified documentation files

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@Cjkjvfnby@cclauss@CaedenPH

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Update developer toolset instructions in CONTRIBUTING.md by Cjkjvfnby · Pull Request #7762 · TheAlgorithms/Python · GitHub
Skip to content
Update developer toolset instructions in CONTRIBUTING.md - #7762
Closed
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Closed
Update developer toolset instructions in CONTRIBUTING.md#7762
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Conversation
@Cjkjvfnby
@CjkjvfnbyCjkjvfnby
commented
Oct 27, 2022

Copy link


Copy Markdown

Contributor
Replace/remove instructions on individual tools usage with pre-commit.

Instruction with flake8 is a bit misleading since the project uses flake8 plugins that should be installed to get the same linting as done by CI on each PR.
Also, add a few line breaks. It doe not affect rendered page and fits into the screen in the editor.
  •  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}.
@algorithms-keeperalgorithms-keeperBot
added

documentation
This PR modified documentation files
awaiting reviews
This PR is ready to be reviewed
labels
Oct 27, 2022
@algorithms-keeperalgorithms-keeperBot
mentioned this pull request
Oct 27, 2022
 Closed

14 tasks
cclauss
cclauss
requested changes
Oct 29, 2022
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

@algorithms-keeperalgorithms-keeperBot
added

awaiting changes
A maintainer has requested changes to this PR
and removed

awaiting reviews
This PR is ready to be reviewed
labels
Oct 29, 2022
@cclausscclauss
added

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
and removed

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
labels
Oct 29, 2022
@Cjkjvfnby
Cjkjvfnbyforce-pushed
the
remove-flake8-mention-from-CONTRIBUTING
branch
from
1a86be3 to
1e07427CompareNovember 5, 2022 22:25
@algorithms-keeperalgorithms-keeperBot
added

awaiting reviews
This PR is ready to be reviewed
and removed

awaiting changes
A maintainer has requested changes to this PR
labels
Nov 5, 2022
@Cjkjvfnby
Cjkjvfnby
requested a review
from cclaussMarch 13, 2023 22:54
cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

CaedenPH
CaedenPH
requested changes
Mar 17, 2023
View reviewed changes
Comment threadCONTRIBUTING.md

Comment on lines

+84
 to 
+90

- Please consider running [__psf/black__](https://github.com/python/black) on your Python file(s) before submitting your pull request. This is not yet a requirement but it does make your code more readable and automatically aligns it with much of [PEP 8](https://www.python.org/dev/peps/pep-0008/). There are other code formatters (autopep8, yapf) but the __black__ formatter is now hosted by the Python Software Foundation. To use it,

 ```bash
 python3 -m pip install black # only required the first time
 black .
 ```

@CaedenPHCaedenPHMar 17, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

In my opinion, this part isn't necessary because when you create the pr the pre-commit bot automatically formats it because it's in the pre-commit
@cclauss
cclauss
commented
Mar 17, 2023

Copy link


Copy Markdown

Member
I do not see the value of these changes.

Some contributors will install pre-commit but the majority will not so…
  • Black corrections will be made automatically so let’s not require it to be installed.
  • The same will be true of Ruff fixes in the future.
  • it is OK to discuss mypy as is currently done because it does not ”fix” code so having it installed locally might be helpful to some contributors.
  • Command line tools like Black, mypy, and ruff should be installed with pipx, not pip.
@Cjkjvfnby
Cjkjvfnby
deleted the

remove-flake8-mention-from-CONTRIBUTING

branch
March 17, 2023 23:06
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cclausscclausscclauss requested changes
@CaedenPHCaedenPHCaedenPH requested changes

Assignees


No one assigned


Labels

awaiting reviewsThis PR is ready to be revieweddocumentationThis PR modified documentation files

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@Cjkjvfnby@cclauss@CaedenPH

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Update developer toolset instructions in CONTRIBUTING.md by Cjkjvfnby · Pull Request #7762 · TheAlgorithms/Python · GitHub
Skip to content
Update developer toolset instructions in CONTRIBUTING.md - #7762
Closed
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Closed
Update developer toolset instructions in CONTRIBUTING.md#7762
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Conversation
@Cjkjvfnby
@CjkjvfnbyCjkjvfnby
commented
Oct 27, 2022

Copy link


Copy Markdown

Contributor
Replace/remove instructions on individual tools usage with pre-commit.

Instruction with flake8 is a bit misleading since the project uses flake8 plugins that should be installed to get the same linting as done by CI on each PR.
Also, add a few line breaks. It doe not affect rendered page and fits into the screen in the editor.
  •  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}.
@algorithms-keeperalgorithms-keeperBot
added

documentation
This PR modified documentation files
awaiting reviews
This PR is ready to be reviewed
labels
Oct 27, 2022
@algorithms-keeperalgorithms-keeperBot
mentioned this pull request
Oct 27, 2022
 Closed

14 tasks
cclauss
cclauss
requested changes
Oct 29, 2022
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

@algorithms-keeperalgorithms-keeperBot
added

awaiting changes
A maintainer has requested changes to this PR
and removed

awaiting reviews
This PR is ready to be reviewed
labels
Oct 29, 2022
@cclausscclauss
added

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
and removed

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
labels
Oct 29, 2022
@Cjkjvfnby
Cjkjvfnbyforce-pushed
the
remove-flake8-mention-from-CONTRIBUTING
branch
from
1a86be3 to
1e07427CompareNovember 5, 2022 22:25
@algorithms-keeperalgorithms-keeperBot
added

awaiting reviews
This PR is ready to be reviewed
and removed

awaiting changes
A maintainer has requested changes to this PR
labels
Nov 5, 2022
@Cjkjvfnby
Cjkjvfnby
requested a review
from cclaussMarch 13, 2023 22:54
cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

CaedenPH
CaedenPH
requested changes
Mar 17, 2023
View reviewed changes
Comment threadCONTRIBUTING.md

Comment on lines

+84
 to 
+90

- Please consider running [__psf/black__](https://github.com/python/black) on your Python file(s) before submitting your pull request. This is not yet a requirement but it does make your code more readable and automatically aligns it with much of [PEP 8](https://www.python.org/dev/peps/pep-0008/). There are other code formatters (autopep8, yapf) but the __black__ formatter is now hosted by the Python Software Foundation. To use it,

 ```bash
 python3 -m pip install black # only required the first time
 black .
 ```

@CaedenPHCaedenPHMar 17, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

In my opinion, this part isn't necessary because when you create the pr the pre-commit bot automatically formats it because it's in the pre-commit
@cclauss
cclauss
commented
Mar 17, 2023

Copy link


Copy Markdown

Member
I do not see the value of these changes.

Some contributors will install pre-commit but the majority will not so…
  • Black corrections will be made automatically so let’s not require it to be installed.
  • The same will be true of Ruff fixes in the future.
  • it is OK to discuss mypy as is currently done because it does not ”fix” code so having it installed locally might be helpful to some contributors.
  • Command line tools like Black, mypy, and ruff should be installed with pipx, not pip.
@Cjkjvfnby
Cjkjvfnby
deleted the

remove-flake8-mention-from-CONTRIBUTING

branch
March 17, 2023 23:06
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cclausscclausscclauss requested changes
@CaedenPHCaedenPHCaedenPH requested changes

Assignees


No one assigned


Labels

awaiting reviewsThis PR is ready to be revieweddocumentationThis PR modified documentation files

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@Cjkjvfnby@cclauss@CaedenPH

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Update developer toolset instructions in CONTRIBUTING.md by Cjkjvfnby · Pull Request #7762 · TheAlgorithms/Python · GitHub
Skip to content
Update developer toolset instructions in CONTRIBUTING.md - #7762
Closed
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Closed
Update developer toolset instructions in CONTRIBUTING.md#7762
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Conversation
@Cjkjvfnby
@CjkjvfnbyCjkjvfnby
commented
Oct 27, 2022

Copy link


Copy Markdown

Contributor
Replace/remove instructions on individual tools usage with pre-commit.

Instruction with flake8 is a bit misleading since the project uses flake8 plugins that should be installed to get the same linting as done by CI on each PR.
Also, add a few line breaks. It doe not affect rendered page and fits into the screen in the editor.
  •  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}.
@algorithms-keeperalgorithms-keeperBot
added

documentation
This PR modified documentation files
awaiting reviews
This PR is ready to be reviewed
labels
Oct 27, 2022
@algorithms-keeperalgorithms-keeperBot
mentioned this pull request
Oct 27, 2022
 Closed

14 tasks
cclauss
cclauss
requested changes
Oct 29, 2022
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

@algorithms-keeperalgorithms-keeperBot
added

awaiting changes
A maintainer has requested changes to this PR
and removed

awaiting reviews
This PR is ready to be reviewed
labels
Oct 29, 2022
@cclausscclauss
added

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
and removed

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
labels
Oct 29, 2022
@Cjkjvfnby
Cjkjvfnbyforce-pushed
the
remove-flake8-mention-from-CONTRIBUTING
branch
from
1a86be3 to
1e07427CompareNovember 5, 2022 22:25
@algorithms-keeperalgorithms-keeperBot
added

awaiting reviews
This PR is ready to be reviewed
and removed

awaiting changes
A maintainer has requested changes to this PR
labels
Nov 5, 2022
@Cjkjvfnby
Cjkjvfnby
requested a review
from cclaussMarch 13, 2023 22:54
cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

CaedenPH
CaedenPH
requested changes
Mar 17, 2023
View reviewed changes
Comment threadCONTRIBUTING.md

Comment on lines

+84
 to 
+90

- Please consider running [__psf/black__](https://github.com/python/black) on your Python file(s) before submitting your pull request. This is not yet a requirement but it does make your code more readable and automatically aligns it with much of [PEP 8](https://www.python.org/dev/peps/pep-0008/). There are other code formatters (autopep8, yapf) but the __black__ formatter is now hosted by the Python Software Foundation. To use it,

 ```bash
 python3 -m pip install black # only required the first time
 black .
 ```

@CaedenPHCaedenPHMar 17, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

In my opinion, this part isn't necessary because when you create the pr the pre-commit bot automatically formats it because it's in the pre-commit
@cclauss
cclauss
commented
Mar 17, 2023

Copy link


Copy Markdown

Member
I do not see the value of these changes.

Some contributors will install pre-commit but the majority will not so…
  • Black corrections will be made automatically so let’s not require it to be installed.
  • The same will be true of Ruff fixes in the future.
  • it is OK to discuss mypy as is currently done because it does not ”fix” code so having it installed locally might be helpful to some contributors.
  • Command line tools like Black, mypy, and ruff should be installed with pipx, not pip.
@Cjkjvfnby
Cjkjvfnby
deleted the

remove-flake8-mention-from-CONTRIBUTING

branch
March 17, 2023 23:06
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cclausscclausscclauss requested changes
@CaedenPHCaedenPHCaedenPH requested changes

Assignees


No one assigned


Labels

awaiting reviewsThis PR is ready to be revieweddocumentationThis PR modified documentation files

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@Cjkjvfnby@cclauss@CaedenPH

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Update developer toolset instructions in CONTRIBUTING.md by Cjkjvfnby · Pull Request #7762 · TheAlgorithms/Python · GitHub
Skip to content
Update developer toolset instructions in CONTRIBUTING.md - #7762
Closed
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Closed
Update developer toolset instructions in CONTRIBUTING.md#7762
Cjkjvfnby wants to merge 5 commits into
TheAlgorithms:masterfrom 
Cjkjvfnby:remove-flake8-mention-from-CONTRIBUTING
Conversation
@Cjkjvfnby
@CjkjvfnbyCjkjvfnby
commented
Oct 27, 2022

Copy link


Copy Markdown

Contributor
Replace/remove instructions on individual tools usage with pre-commit.

Instruction with flake8 is a bit misleading since the project uses flake8 plugins that should be installed to get the same linting as done by CI on each PR.
Also, add a few line breaks. It doe not affect rendered page and fits into the screen in the editor.
  •  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}.
@algorithms-keeperalgorithms-keeperBot
added

documentation
This PR modified documentation files
awaiting reviews
This PR is ready to be reviewed
labels
Oct 27, 2022
@algorithms-keeperalgorithms-keeperBot
mentioned this pull request
Oct 27, 2022
 Closed

14 tasks
cclauss
cclauss
requested changes
Oct 29, 2022
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

@algorithms-keeperalgorithms-keeperBot
added

awaiting changes
A maintainer has requested changes to this PR
and removed

awaiting reviews
This PR is ready to be reviewed
labels
Oct 29, 2022
@cclausscclauss
added

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
and removed

ON HOLD: Final hours of Hacktoberfest
We will review this PR after Hacktoberfest has ended
labels
Oct 29, 2022
@Cjkjvfnby
Cjkjvfnbyforce-pushed
the
remove-flake8-mention-from-CONTRIBUTING
branch
from
1a86be3 to
1e07427CompareNovember 5, 2022 22:25
@algorithms-keeperalgorithms-keeperBot
added

awaiting reviews
This PR is ready to be reviewed
and removed

awaiting changes
A maintainer has requested changes to this PR
labels
Nov 5, 2022
@Cjkjvfnby
Cjkjvfnby
requested a review
from cclaussMarch 13, 2023 22:54
cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

cclauss
cclauss
reviewed
Mar 13, 2023
View reviewed changes
Comment threadCONTRIBUTING.md
Outdated

CaedenPH
CaedenPH
requested changes
Mar 17, 2023
View reviewed changes
Comment threadCONTRIBUTING.md

Comment on lines

+84
 to 
+90

- Please consider running [__psf/black__](https://github.com/python/black) on your Python file(s) before submitting your pull request. This is not yet a requirement but it does make your code more readable and automatically aligns it with much of [PEP 8](https://www.python.org/dev/peps/pep-0008/). There are other code formatters (autopep8, yapf) but the __black__ formatter is now hosted by the Python Software Foundation. To use it,

 ```bash
 python3 -m pip install black # only required the first time
 black .
 ```

@CaedenPHCaedenPHMar 17, 2023

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

In my opinion, this part isn't necessary because when you create the pr the pre-commit bot automatically formats it because it's in the pre-commit
@cclauss
cclauss
commented
Mar 17, 2023

Copy link


Copy Markdown

Member
I do not see the value of these changes.

Some contributors will install pre-commit but the majority will not so…
  • Black corrections will be made automatically so let’s not require it to be installed.
  • The same will be true of Ruff fixes in the future.
  • it is OK to discuss mypy as is currently done because it does not ”fix” code so having it installed locally might be helpful to some contributors.
  • Command line tools like Black, mypy, and ruff should be installed with pipx, not pip.
@Cjkjvfnby
Cjkjvfnby
deleted the

remove-flake8-mention-from-CONTRIBUTING

branch
March 17, 2023 23:06
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@cclausscclausscclauss requested changes
@CaedenPHCaedenPHCaedenPH requested changes

Assignees


No one assigned


Labels

awaiting reviewsThis PR is ready to be revieweddocumentationThis PR modified documentation files

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

3 participants

@Cjkjvfnby@cclauss@CaedenPH