Skip to content

Improved README.md - #1757

Closed
SATHIYAIT wants to merge 1 commit into
TheAlgorithms:masterfrom
SATHIYAIT:master
Closed

Improved README.md#1757
SATHIYAIT wants to merge 1 commit into
TheAlgorithms:masterfrom
SATHIYAIT:master

Conversation

@SATHIYAIT

Copy link
Copy Markdown

Describe your change:

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

References

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 Java files are placed inside an existing directory.
  • All filenames are in all uppercase characters with no spaces or dashes.
  • All functions and variable names follow Java naming conventions.
  • 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}.

@SethFalco SethFalco left a comment

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.

I'm not a maintainer, but I saw this and just left some comments anyway.

Comment thread README.md

### All algorithms are implemented in Java (for educational purposes)
These implementations are for learning purposes. The implementations may be less efficient than the Java standard library.
This implementations are only for learning purposes. The implementations is probably less efficient than the Java standard library.

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.

The old sentence was perfectly fine, the new one is grammatically incorrect.

Comment thread README.md

## Community Channel
We're on [Gitter](https://gitter.im/TheAlgorithms)! Please join us.
We are on [Gitter](https://gitter.im/TheAlgorithms)! Please join us.

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.

This isn't an improvement at all, apostrophes are good things.

Comment thread README.md


NOTE: A [Development](https://github.com/TheAlgorithms/Java/tree/Development) branch is made for this repo where we're trying to migrate the existing project to a Java project structure. You can switch to [Development](https://github.com/TheAlgorithms/Java/tree/Development) branch for contributions. Please refer [this issue](https://github.com/TheAlgorithms/Java/issues/474) for more info.
NOTE: A [Development](https://github.com/TheAlgorithms/Java/tree/Development) branch is made for this repo where we are trying are best to migrate the existing project to a Java project structure. You can switch to [Development](https://github.com/TheAlgorithms/Java/tree/Development) branch for contributions. Please refer [this issue](https://github.com/TheAlgorithms/Java/issues/474) for more info.

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.

This is also grammatically incorrect.
Also it's "our best" not "are best".

@SATHIYAIT
SATHIYAIT requested a review from siriak as a code owner September 17, 2021 09:47
@github-actions

Copy link
Copy Markdown

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions Bot added the stale label Sep 26, 2021
@github-actions

Copy link
Copy Markdown

Please reopen this pull request once you commit the changes requested or make improvements on the code. If this is not the case and you need some help, feel free to seek help from our Gitter or ping one of the reviewers. Thank you for your contributions!

@github-actions github-actions Bot closed this Sep 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants