Add contributing manual #570
Open
+36
−0
Conversation
This file contains 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
|
|
||
| ## Dependency Structure | ||
|
|
||
| There is a tree dependency structure to the sublibraries of NonlinearSolve.jl. The core subpackage NonlinearSolveBase.jl is the hard dependency of all the other subpackages. SimpleNonlinearSolve.jl is a special one with BracketingNonlinearSolve.jl as dependency. NonlinearSolve.jl as the parent package contains all of the subpackages. |
There was a problem hiding this comment.
SimpleNonlinearSolve.jl is a special one with BracketingNonlinearSolve.jl as dependency.
That should change.
There was a problem hiding this comment.
Do you mean that we should no longer use and reexport BracketingNonlinearSolve in SimpleNonlinearSolve?
|
we should just use sources instead of having to manually dev https://github.com/LuxDL/Lux.jl/blob/f6cecd2ba03fd9f8d784b3fa9b5c8e667fe7314f/Project.toml#L56-L60 |
fgittins
reviewed
Apr 6, 2025
| the total number of dependencies per solver. As a consequence, it requires a bit of special | ||
| handling compared to some other Julia packages. | ||
|
|
||
| When running the subpackage test suite, it's recommended that one has dev'd its relevant packages in NonlinearSolve.jl. This can be done via(use `NonlinearSolveFirstOrder` as example): |
There was a problem hiding this comment.
Some minor typos. Should probably be:
via (with `NonlinearSolveFirstOrder` as an example)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add some context for developing NonlinearSolve