Skip to content

Add README.md files #5586

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

Closed
wants to merge 22 commits into from
Closed

Add README.md files #5586

wants to merge 22 commits into from

Conversation

Leoriem-code
Copy link
Contributor

Describe your change:

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

@cclauss
Copy link
Member

cclauss commented Oct 24, 2021

@cclauss cclauss requested review from poyea and dhruvmanila October 24, 2021 21:13
@Leoriem-code
Copy link
Contributor Author

I tried to give broad explanations so that it wouldn't replicates those.
Should I open a push request there too ?

@Leoriem-code Leoriem-code marked this pull request as ready for review October 25, 2021 12:23
@ghost ghost added awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files labels Oct 25, 2021
@Leoriem-code Leoriem-code requested a review from cclauss October 28, 2021 11:42
Leoriem-code and others added 2 commits October 28, 2021 16:09
@poyea
Copy link
Member

poyea commented Oct 28, 2021

Please check against your sentences. Sometimes, you want to write in a more formal / less personal way, but be sure spellings and sentences are right.

@Leoriem-code
Copy link
Contributor Author

You are right, I will check again

@Leoriem-code Leoriem-code requested a review from poyea November 2, 2021 19:01
@Leoriem-code
Copy link
Contributor Author

Leoriem-code commented Nov 2, 2021

I need to clean my fork of this repository, so I will close this push request, delete my fork, fork it again and continue where I left.

@Leoriem-code Leoriem-code mentioned this pull request Nov 2, 2021
14 tasks
@cclauss
Copy link
Member

cclauss commented Nov 2, 2021

Please try to keep PRs reasonable to review. 39 files is too much for a single PR that is not software generated (black, isort, etc.).

@Leoriem-code
Copy link
Contributor Author

Should I close the request and open a PR for each README file ?

@cclauss
Copy link
Member

cclauss commented Nov 2, 2021

Before Hactoberfest we had 20 open PRs and today we have 194 so you understand our frustration...

5 files at a time seems to be reasonable.

@Leoriem-code
Copy link
Contributor Author

Leoriem-code commented Nov 2, 2021

No problem, 1/7: #5754

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting reviews This PR is ready to be reviewed documentation This PR modified documentation files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants