Any contribution to CSP-Rules-Examples is welcome.
There are several ways you can contribute to it.
The following are non restrictive suggestions, any other idea is welcome, but the general rules of good conduct will be applied strictly: no PR that doesn't respect them will be taken into consideration.
As a general background for these rules, you should always keep in mind that the CSP-Rules user is not supposed to be a programmer, let alone an expert one. The goal of the examples is either to illustrate some resolution rule(s) or to describe some general results.
- For any change you want to propose, make a fork and a Pull Request.
Adding more examples is not a goal per se.
However, you can propose an example for inclusion:
- if it provides a better illustration of a resolution rule than an existing one;
- if it has some interesting characteristics not shown in the other examples;
- if it provides a different solution for an existing example;
In any case, do not forget to describe the full configuration choices made in your example.
If your example involves solving with CSP-Rules-V2.1 a collection of puzzles in a .txt file or .csv file or in any other format, don't forget to write the full command you used to do this, always referring to files via the ?CSP-Rules-Exampes global variable of CSP-Rules-V2.1.
If your example requires some additional code to read or solve it, don't forget to include it.