Skip to content

Commit f27871c

Browse files
committed
logo-v1
1 parent 68cc769 commit f27871c

4 files changed

Lines changed: 192 additions & 19 deletions

File tree

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Problem Reductions
1+
![100-Problem-Reductions](docs/logo.svg)
22

33
[![CI](https://github.com/CodingThrust/problem-reductions/actions/workflows/ci.yml/badge.svg)](https://github.com/CodingThrust/problem-reductions/actions/workflows/ci.yml)
44
[![codecov](https://codecov.io/github/CodingThrust/problem-reductions/graph/badge.svg?token=0CdEC8GHN0)](https://codecov.io/github/CodingThrust/problem-reductions)
5-
[![Documentation](https://github.com/CodingThrust/problem-reductions/actions/workflows/docs.yml/badge.svg)](https://codingthrust.github.io/problem-reductions/)
5+
[![Docs](https://img.shields.io/badge/Docs-API-green)](https://codingthrust.github.io/problem-reductions/)
66
[![PDF Manual](https://img.shields.io/badge/PDF-Manual-blue)](https://codingthrust.github.io/problem-reductions/reductions.pdf)
77
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
88

9-
A Rust library for NP-hard problem definitions and reductions. We aim to implement >100 NP-hard problems and reductions rule between them, under the help of AI.
9+
A Rust library for NP-hard problem definitions and reductions. We aim to implement >100 NP-hard problems and reductions rule between them, under the assistance of AI.
1010

1111
## Installation
1212

@@ -39,7 +39,22 @@ let solution = reduction.extract_solution(&ilp_solution);
3939
assert_eq!(solution.iter().sum::<usize>(), 2); // Max IS size is 2
4040
```
4141

42-
## Development
42+
## Contributing
43+
44+
### Authorship Recognition
45+
46+
**Contribute 10 non-trivial reduction rules and you will be automatically added to the author list of the paper.** To facilitate the development, we provide the AI tools to help developers implement their *plans*. Developers still need to carefully design the test cases and verify the correctness of the reduction rules.
47+
48+
**Step by step**
49+
50+
1. Find or create a GitHub issue describing your proposal, which rule to add and how to test it. You may have some discussions with other developers to refine the proposal.
51+
2. Write a detailed plan in `docs/plans/issue-<number>-<slug>.md`.
52+
- If you use [Claude Code](https://github.com/anthropics/claude-code), it is recommended to use the [issue-to-pr](.claude/skills/issue-to-pr.md) skill. The skill will invoke [superpowers:brainstorm](https://github.com/obra/superpowers) to help you write a detailed plan:
53+
```
54+
/issue-to-pr <issue-number>
55+
```
56+
Afterwards, the skill creates a PR starting with `[action]`, which automatically triggers Claude CI to implement the plan.
57+
- Otherwise, you can write a detailed plan manually ([sample](docs/plans/2026-01-31-factoring-ilp-design.md)). Then create a PR manually. You can start implementing this plan on the CI machine by adding `[action]` at the start of the PR description or comments.
4358
4459
### Using Make
4560
@@ -56,21 +71,6 @@ make clean # Clean build artifacts
5671
make check # Quick check before commit (fmt + clippy + test)
5772
```
5873

59-
## Contributing
60-
61-
### Authorship Recognition
62-
63-
**Contribute 10 non-trivial reduction rules and you will be automatically added to the author list of the paper.** To facilitate the development, we provide the AI tools to help developers implement their *plans*. Developers still need to carefully design the test cases and verify the correctness of the reduction rules.
64-
65-
### Using Claude Code (Recommended)
66-
67-
1. Find or create a GitHub issue describing your contribution
68-
2. Run the issue-to-pr skill:
69-
```
70-
/issue-to-pr <issue-number>
71-
```
72-
3. Brainstorm with Claude using `superpowers:brainstorming` to clarify requirements
73-
4. The skill creates a PR starting with `[action]`, which automatically triggers Claude CI to implement the plan
7474

7575
## License
7676

docs/logo.png

45.3 KB
Loading

0 commit comments

Comments
 (0)