Skip to content

Commit 4130ff2

Browse files
Update Making Changes section in CONTRIBUTING.md
1 parent 2aedc96 commit 4130ff2

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ If you find any bugs in this library, please submit an issue here on GitHub and
77
If you have a feature that you'd like added to this library, submit an issue here on GitHub. We can talk about feasibility, whether it fits in with the rest of the library, etc. If you'd like to try implementing the feature yourself after we decide that it is a good addition, let me know and then feel free to submit a pull request! I also don't have anything against drive-by pull requests, but it's probably best to check via an issue first to make sure that it's a good idea and that no one else is working on it before you put in the time.
88

99
## Making Changes
10-
After submitting an issue for your bug / feature request, if you want to make a pull request, go ahead! The code should be fairly well-documented, and if it's not well-documented and you find it very confusing, let me know and I'll try to improve the documentation. When submitting code, you'll notice that most of the current code uses the same `generalizedSearch` function at its core. Feel free to not do this with your submitted code--I would rather have more algorithms, implemented separately and with code duplication, than to have less algorithms and "more elegant" code.
10+
After submitting an issue for your bug / feature request, if you want to make a pull request, go ahead! The code should be fairly well-documented, and if it's not well-documented and you find it very confusing, let me know and I'll try to improve the documentation. Adding tests for your changes is preferred when practical, and any new functions or features should be documented. When modifying the current code, you'll notice that most of the searches use the same `generalizedSearch` function at their core. Feel free to not do this with your submitted code--I would rather have more algorithms, implemented separately and with code duplication, than to have less algorithms and "more elegant" code.

0 commit comments

Comments
 (0)