Skip to content

docs: mention CI in the contribution guide #97

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.

Sign up for GitHub

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
merged 2 commits into from
Mar 17, 2025
Merged

docs: mention CI in the contribution guide #97

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d97d7ad
docs: mention CI in the contribution guide
KnorpelSenf Mar 17, 2025
fc6bd36
docs: fix indentation
KnorpelSenf Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ Adding a new solver should not take more than a few hundred lines of code, tests
You can generally reuse data structures provided by the library for which you are creating a wrapper.
- implement a function named after your solver that takes an [`UnsolvedProblem`](https://docs.rs/good_lp/latest/good_lp/variable/struct.UnsolvedProblem.html) and returns the struct you defined above.
- implement the [`SolverModel`](https://docs.rs/good_lp/latest/good_lp/index.html#reexport.SolverModel) trait for your new problem type.
- add your solver to `lib.rs` and to the `all_default_solvers` feature in Cargo.toml.
- open a [pull request](https://github.com/rust-or/good_lp/pulls)
- add your solver to `lib.rs` and to the `all_default_solvers` feature in Cargo.toml.
- run the tests of your solver [in the CI setup]([url](https://github.com/rust-or/good_lp/blob/main/.github/workflows/rust.yml))
- open a [pull request](https://github.com/rust-or/good_lp/pulls)

## Dev Container Setup

Expand Down
Loading