Skip to content

Add contributing manual#570

Open
ErikQQY wants to merge 2 commits intomasterfrom
qqy/contributing
Open

Add contributing manual#570
ErikQQY wants to merge 2 commits intomasterfrom
qqy/contributing

Conversation

@ErikQQY
Copy link
Copy Markdown
Member

@ErikQQY ErikQQY commented Apr 5, 2025

Add some context for developing NonlinearSolve

Comment thread CONTRIBUTING.md

## 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.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SimpleNonlinearSolve.jl is a special one with BracketingNonlinearSolve.jl as dependency.

That should change.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean that we should no longer use and reexport BracketingNonlinearSolve in SimpleNonlinearSolve?

@avik-pal
Copy link
Copy Markdown
Member

avik-pal commented Apr 5, 2025

we should just use sources instead of having to manually dev https://github.com/LuxDL/Lux.jl/blob/f6cecd2ba03fd9f8d784b3fa9b5c8e667fe7314f/Project.toml#L56-L60

Comment thread CONTRIBUTING.md
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):
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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants