From d97d7ad0a27566c3eb9a34cceb03240182915163 Mon Sep 17 00:00:00 2001 From: KnorpelSenf Date: Mon, 17 Mar 2025 15:54:34 +0100 Subject: [PATCH 1/2] docs: mention CI in the contribution guide --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc07392..214bfef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,7 @@ Adding a new solver should not take more than a few hundred lines of code, tests - 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. + - 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 From fc6bd361e328fa0ee096e62cf35017bf28eb8cb2 Mon Sep 17 00:00:00 2001 From: KnorpelSenf Date: Mon, 17 Mar 2025 15:56:50 +0100 Subject: [PATCH 2/2] docs: fix indentation --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 214bfef..7f898c1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,9 +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. - - 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) +- 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