From af455e6abbf681b18311587d925a8501bdeee218 Mon Sep 17 00:00:00 2001 From: Shlomi Fish Date: Thu, 6 Sep 2018 08:17:54 +0300 Subject: [PATCH] add more docs. --- CONTRIBUTING.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d98ef6f7..6a664fd5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,19 @@ for general guidelines for contributing to open source. - Try to fix bugs. - Add new games. - Improve the documentation / online help -- Refactor the code. +- [Refactor](https://en.wikipedia.org/wiki/Code_refactoring) the code. - Add new features. - Contribute graphics +- Improve the site +- Make a monetary donation. + +## Adding new games + +First of all there is the "Solitaire Wizard" which may be used to generate many +custom variants. It lives in the Edit menu. + +Otherwise, the games' sources live under +[the pysollib/games/](pysollib/games/) directory in the repository, and are +written in Python 2.7/3.x and you can try inheriting from an existing +variant [class](https://en.wikipedia.org/wiki/Class_%28computer_programming%29). +