Skip to content
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.

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

Note: a starter guide to contribute this project #32

Open
GiggleLiu opened this issue Jul 10, 2024 · 0 comments
Open

Note: a starter guide to contribute this project #32

GiggleLiu opened this issue Jul 10, 2024 · 0 comments
Labels
good first issue Good for newcomers

Comments

@GiggleLiu
Copy link
Owner

GiggleLiu commented Jul 10, 2024

Code

  1. Add a new model: https://github.com/GiggleLiu/ProblemReductions.jl/tree/main/src/models
  2. Add a new rule: https://github.com/GiggleLiu/ProblemReductions.jl/tree/main/src/rules , the correctness of your reduction should be tested here: https://github.com/GiggleLiu/ProblemReductions.jl/blob/main/test/rules/rules.jl

Documentation

To get started, you can deploy the documentation locally with a single command:

$ make init
$ make serve

To contribute an example, please check this folder:
https://github.com/GiggleLiu/ProblemReductions.jl/tree/main/examples

The tool we are using is Literate

@GiggleLiu GiggleLiu added the good first issue Good for newcomers label Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant