-
-
Notifications
You must be signed in to change notification settings - Fork 398
Add missing docs and upgrade dependencies #66
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
Merged
counter2015
merged 5 commits into
TheAlgorithms:master
from
sentenza:9-readme-and-updates
Oct 12, 2021
Merged
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,56 @@ | ||
# dotenv | ||
.env | ||
## sbt | ||
logs | ||
target | ||
/.idea | ||
/.idea_modules | ||
/.classpath | ||
/.gradle | ||
/.project | ||
/.gradle | ||
/.settings | ||
/public/* | ||
|
||
# virtualenv | ||
venv/ | ||
ENV/ | ||
# sbt specific | ||
.cache | ||
.history | ||
.lib/ | ||
.bsp/ | ||
dist/* | ||
lib_managed/ | ||
src_managed/ | ||
project/boot/ | ||
|
||
# Rope project settings | ||
# Scala-IDE specific | ||
.scala_dependencies | ||
.worksheet | ||
.ropeproject | ||
.idea | ||
|
||
# Temporary | ||
.netrwhist | ||
*~ | ||
|
||
# Vim specific --- | ||
# Swap | ||
[._]*.s[a-v][a-z] | ||
[._]*.sw[a-p] | ||
[._]s[a-v][a-z] | ||
[._]sw[a-p] | ||
._* | ||
*.swp | ||
*.swo | ||
|
||
# System Files | ||
.DS_Store | ||
Thumbs.db% | ||
|
||
## Metals | ||
.metals | ||
.bloop | ||
|
||
# sbt specific | ||
target/ | ||
project/target | ||
# dotenv | ||
.env | ||
|
||
# virtualenv | ||
venv/ | ||
ENV/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
version = "3.0.6" | ||
|
||
runner.dialect = scala213source3 | ||
align.preset = more | ||
style = defaultWithAlign | ||
maxColumn = 115 | ||
docstrings.style = SpaceAsterisk | ||
docstrings.removeEmpty = true | ||
continuationIndent.callSite = 2 | ||
continuationIndent.defnSite = 4 | ||
includeCurlyBraceInSelectChains = false | ||
project.git = true | ||
project.excludeFilters = ["target/"] | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
## How to contribute? | ||
|
||
#### Did you find a bug? | ||
|
||
* **Ensure the bug was not already reported** by searching on GitHub | ||
under [Project Issues](https://github.com/TheAlgorithms/Scala/issues). | ||
* Please avoid opening issues asking to be "assigned" to a particular algorithm. This merely creates unnecessary noise | ||
for maintainers. Instead, please submit your implementation in a pull request, and it will be evaluated by project | ||
maintainers. | ||
* If you are unable to find an open issue referring to the same problem, depending on the type of issue follow the | ||
appropriate steps: | ||
|
||
#### Do you want to contribute to the documentation? | ||
|
||
- Please read the documentation in | ||
here [Contributing to the Documentation](https://github.com/TheAlgorithms/Scala/blob/master/CONTRIBUTING.md), | ||
[open a new one issue](https://github.com/TheAlgorithms/Scala/issues/new), make changes and then create a pull | ||
request, it will be put under review and accepted if it is appropriate. | ||
|
||
#### Do you want to add a new feature? | ||
|
||
* [Open a new one issue](https://github.com/TheAlgorithms/Scala/issues/new). Be sure to include a **title and a clear | ||
description** and a **test case** demonstrating the new feature that you want to add to the project. | ||
|
||
##### Contributing to Algorithms (Make sure to check all the points below before opening a PR) | ||
|
||
* Make sure you follow proper coding standards and naming conventions. | ||
* Please | ||
use [Binary Search Implementation](https://github.com/TheAlgorithms/Scala/blob/master/src/main/scala/Search/BinarySearch.scala) | ||
* | ||
and [Binary Search Test](https://github.com/TheAlgorithms/Scala/blob/master/src/test/scala/Search/BinarySearchSpec.scala) | ||
as a reference. | ||
* Add the algorithm implementation as an object and not as a class | ||
* Add proper comments about the algorithm implementation and the functions present in the algorithm | ||
* Add a test spec in the test folder under the same domain as that of your algorithm. **PRs without a test spec would | ||
not be accepted!** | ||
* Add at least 1 positive and 1 negative test in the test spec | ||
* Raise a PR for the algorithm object file and the test spec | ||
* [How to write a test case in Scala](http://www.scalatest.org/user_guide/writing_your_first_test) | ||
|
||
#### Contributing to Tests | ||
|
||
* You can contribute tests for a specific algorithm | ||
* Add as many tests as you can and try to cover all the borderline test cases | ||
* Open a PR with for your testSpec | ||
* Make sure you are not adding redundant test cases | ||
* If you see that the algorithm fails for a particular test case, then open an issue with proper explanation. | ||
* [How to write a test case in Scala](http://www.scalatest.org/user_guide/writing_your_first_test) | ||
|
||
#### Do you want to fix a bug? | ||
|
||
* [Open a new issue](https://github.com/TheAlgorithms/Scala/issues/new).Be sure to include a **title and a clear | ||
description** and a **test case** demonstrating the expected behaviour that is not occurring. | ||
|
||
#### **Do you have questions about the source code?** | ||
|
||
* Ask any question about how to use the repository in | ||
the [TheAlgorithms room in GITTER](https://gitter.im/TheAlgorithms/community?source=orgpage#) or | ||
[open a new one issue](https://github.com/TheAlgorithms/Scala/issues/new) | ||
|
||
:+1::tada: That's all you need to know about the process now it's your turn to help us improve the repository, thank you | ||
again! :+1::tada: |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.