Prolog Coding Guidelines - Revision history

Michael Leuschel: /* General Guidelines */

2021-03-22T08:58:08Z

General Guidelines

← Older revision		Revision as of 08:58, 22 March 2021
Line 9:		Line 9:
	Concerning naming of identifiers: try to use names for constants, functors and predicates that are unique and not a prefix of other names. This ensures that one can quickly find all uses/definitions with grep or BBEdit.		Concerning naming of identifiers: try to use names for constants, functors and predicates that are unique and not a prefix of other names. This ensures that one can quickly find all uses/definitions with grep or BBEdit.

	Use the [https://biratkirat.medium.com/step-8-the-boy-scout-rule-robert-c-martin-uncle-bob-9ac839778385 ~~Boy Scout~~ rule]: "Always leave the code you are editing a little better than you found it".		Use the [https://biratkirat.medium.com/step-8-the-boy-scout-rule-robert-c-martin-uncle-bob-9ac839778385 boy scout rule]: "Always leave the code you are editing a little better than you found it".
	In particular, the second time around is often a good time for adding comments.		In particular, the second time around is often a good time for adding comments.

Michael Leuschel: /* General Guidelines */

2021-03-22T08:57:46Z

General Guidelines

← Older revision		Revision as of 08:57, 22 March 2021
Line 8:		Line 8:

	Concerning naming of identifiers: try to use names for constants, functors and predicates that are unique and not a prefix of other names. This ensures that one can quickly find all uses/definitions with grep or BBEdit.		Concerning naming of identifiers: try to use names for constants, functors and predicates that are unique and not a prefix of other names. This ensures that one can quickly find all uses/definitions with grep or BBEdit.

			Use the [https://biratkirat.medium.com/step-8-the-boy-scout-rule-robert-c-martin-uncle-bob-9ac839778385 Boy Scout rule]: "Always leave the code you are editing a little better than you found it".
			In particular, the second time around is often a good time for adding comments.

	= Module Information =		= Module Information =

Michael Leuschel: /* Git */

2021-03-19T09:36:37Z

Git

← Older revision		Revision as of 09:36, 19 March 2021
Line 64:		Line 64:
	* Wrap the body at 72 characters		* Wrap the body at 72 characters
	* Use the body to explain what and why vs. how		* Use the body to explain what and why vs. how
			* Note: you can use <tt>git commit -m "Title" -m "Description"</tt> to add descriptions to a commit
			* Ideally: always create a test or ticket (or ideally both) for a bug fix

	= Useful Bash Aliases =		= Useful Bash Aliases =

David Geleßus: Fix plcoding.pdf link

2021-02-03T16:47:47Z

Fix plcoding.pdf link

← Older revision		Revision as of 16:47, 3 February 2021
Line 5:		Line 5:
	Ideally, try to get rid of warnings as well.		Ideally, try to get rid of warnings as well.

	Have a look at the paper by [[http://www.ai.~~uga.edu~~/mc/plcoding.pdf Covington et al.]] on Prolog coding guidelines.		Have a look at the paper by [http://www.covingtoninnovations.com/mc/plcoding.pdf Covington et al.] on Prolog coding guidelines.

	Concerning naming of identifiers: try to use names for constants, functors and predicates that are unique and not a prefix of other names. This ensures that one can quickly find all uses/definitions with grep or BBEdit.		Concerning naming of identifiers: try to use names for constants, functors and predicates that are unique and not a prefix of other names. This ensures that one can quickly find all uses/definitions with grep or BBEdit.

Michael Leuschel: /* Git */

2021-01-13T10:30:47Z

Git

← Older revision		Revision as of 10:30, 13 January 2021
Line 55:		Line 55:
	* run integration tests before pushing your changes (ideally also before committing to avoid later issues with git bisect); ideally you should run as many tests as possible, but at least those affecting the parts you have changed. See alias below to start the test REPL. The command "test" then starts the ProB Test REPL. Type something like "tickets" to run all non-regression tests related to tickets.		* run integration tests before pushing your changes (ideally also before committing to avoid later issues with git bisect); ideally you should run as many tests as possible, but at least those affecting the parts you have changed. See alias below to start the test REPL. The command "test" then starts the ProB Test REPL. Type something like "tickets" to run all non-regression tests related to tickets.
	* as a rule of thumb: use rebase before pushing your changes to gitlab, especially when you only have one real commit.		* as a rule of thumb: use rebase before pushing your changes to gitlab, especially when you only have one real commit.
			* avoid merge bombs with many changed files: a Git merge can hide unintended changes, e.g., accidentally reverting previous commits because of editor issues (editor out of sync with file system).
			* provide good commit messages. If a commit is related to a JIRA/Gitlab/Github ticket reference the identifier of the ticket in the commit message. This web page provides the following seven rules:
			* Separate subject from body with a blank line
			* Limit the subject line to 50 characters
			* Capitalize the subject line
			* Do not end the subject line with a period
			* Use the imperative mood in the subject line
			* Wrap the body at 72 characters
			* Use the body to explain what and why vs. how

	= Useful Bash Aliases =		= Useful Bash Aliases =

Michael Leuschel: /* Useful Bash Aliases */

2021-01-13T10:08:16Z

Useful Bash Aliases

← Older revision		Revision as of 10:08, 13 January 2021
Line 63:		Line 63:

	To run probcli with the REPL from sources:		To run probcli with the REPL from sources:
	alias seval='~~cd $NEWPROBDIR;~~ rlwrap sicstus -l $PROB_SOURCE_DIR/prob_cli.pl --goal "go_cli." -a -repl -init -p WARN_WHEN_EXPANDING_INFINITE_CLOSURES 0 -p CLPFD TRUE'		alias seval='rlwrap sicstus -l $PROB_SOURCE_DIR/prob_cli.pl --goal "go_cli." -a -repl -init -p WARN_WHEN_EXPANDING_INFINITE_CLOSURES 0 -p CLPFD TRUE'

	To run ProB Tcl/Tk from sources:		To run ProB Tcl/Tk from sources:
	alias prob='~~cd $PROB_SOURCE_DIR;~~ unlimit; sics -Dprob_profile=true -l $PROB_SOURCE_DIR/prob_tcltk.pl --goal "go."'		alias prob='unlimit; sics -Dprob_profile=true -l $PROB_SOURCE_DIR/prob_tcltk.pl --goal "go."'

	To run the ProB Test REPL from sources:		To run the ProB Test REPL from sources:
	alias test='cd $PROB_SOURCE_DIR/..; rlwrap sicstus -Dprob_safe_mode=true -l $PROB_SOURCE_DIR/test_runner.pl --goal "test_repl."'		alias test='cd $PROB_SOURCE_DIR/..; rlwrap sicstus -Dprob_safe_mode=true -l $PROB_SOURCE_DIR/test_runner.pl --goal "test_repl."'

Michael Leuschel: /* General Guidelines */

2017-02-10T11:06:48Z

General Guidelines

← Older revision		Revision as of 11:06, 10 February 2017
Line 6:		Line 6:

	Have a look at the paper by [[http://www.ai.uga.edu/mc/plcoding.pdf Covington et al.]] on Prolog coding guidelines.		Have a look at the paper by [[http://www.ai.uga.edu/mc/plcoding.pdf Covington et al.]] on Prolog coding guidelines.

			Concerning naming of identifiers: try to use names for constants, functors and predicates that are unique and not a prefix of other names. This ensures that one can quickly find all uses/definitions with grep or BBEdit.

	= Module Information =		= Module Information =

Michael Leuschel: /* Errors */

2017-02-10T11:05:15Z

Errors

← Older revision		Revision as of 11:05, 10 February 2017
Line 40:		Line 40:

	Errors should be raised using one of the <tt>add_error</tt> predicates in the <tt>error_manager</tt> module. This will ensure that the errors are brought to the attention of the user in an appropriate way, depending on whether the Rodin, the Tcl/Tk, the command-line version is run and also depending on whether the tool is in testing and/or batch mode.		Errors should be raised using one of the <tt>add_error</tt> predicates in the <tt>error_manager</tt> module. This will ensure that the errors are brought to the attention of the user in an appropriate way, depending on whether the Rodin, the Tcl/Tk, the command-line version is run and also depending on whether the tool is in testing and/or batch mode.

			Note: for internal errors that should never occur use the <tt>add_internal_error</tt> predicate.
			This ensures that the [https://www3.hhu.de/stups/internal/coverage/html/ coverage information] is shown accordingly (in blue rather than red in the highlighting and this also affects coverage statistics).

	= Preferences =		= Preferences =

Michael Leuschel: /* Git */

2014-12-05T14:59:53Z

Git

← Older revision		Revision as of 14:59, 5 December 2014
Line 49:		Line 49:
	* before committing ensure that probcli can be built (make prob); otherwise git bisect gets annoying to use (one can use git bisect skip to some extent, but it is annoying)		* before committing ensure that probcli can be built (make prob); otherwise git bisect gets annoying to use (one can use git bisect skip to some extent, but it is annoying)
	* run integration tests before pushing your changes (ideally also before committing to avoid later issues with git bisect); ideally you should run as many tests as possible, but at least those affecting the parts you have changed. See alias below to start the test REPL. The command "test" then starts the ProB Test REPL. Type something like "tickets" to run all non-regression tests related to tickets.		* run integration tests before pushing your changes (ideally also before committing to avoid later issues with git bisect); ideally you should run as many tests as possible, but at least those affecting the parts you have changed. See alias below to start the test REPL. The command "test" then starts the ProB Test REPL. Type something like "tickets" to run all non-regression tests related to tickets.
	* as a rule of thumb: use rebase before pushing your changes to gitlab, especially when you only have one real commit.		* as a rule of thumb: use rebase before pushing your changes to gitlab, especially when you only have one real commit.

	= Useful Bash Aliases =		= Useful Bash Aliases =

Michael Leuschel at 14:59, 5 December 2014

2014-12-05T14:59:40Z

← Older revision		Revision as of 14:59, 5 December 2014
Line 43:		Line 43:
	= Preferences =		= Preferences =

	Preferences should be declared in the <tt>preferences</pl> module. Each preference must have a default value, a textual description, a type and category. Optionally, a short string for setting the preference from the command-line can be given (using the <tt>-p PREF VALUE</tt> switch).		Preferences should be declared in the <tt>preferences</tt> module. Each preference must have a default value, a textual description, a type and category. Optionally, a short string for setting the preference from the command-line can be given (using the <tt>-p PREF VALUE</tt> switch).

			= Git =

			* before committing ensure that probcli can be built (make prob); otherwise git bisect gets annoying to use (one can use git bisect skip to some extent, but it is annoying)
			* run integration tests before pushing your changes (ideally also before committing to avoid later issues with git bisect); ideally you should run as many tests as possible, but at least those affecting the parts you have changed. See alias below to start the test REPL. The command "test" then starts the ProB Test REPL. Type something like "tickets" to run all non-regression tests related to tickets.
			* as a rule of thumb: use rebase before pushing your changes to gitlab, especially when you only have one real commit.

			= Useful Bash Aliases =


			To run probcli from sources:
			alias probsli='rlwrap sicstus -l $PROB_SOURCE_DIR/prob_cli.pl --goal "go_cli." -a'

			To run probcli with the REPL from sources:
			alias seval='cd $NEWPROBDIR; rlwrap sicstus -l $PROB_SOURCE_DIR/prob_cli.pl --goal "go_cli." -a -repl -init -p WARN_WHEN_EXPANDING_INFINITE_CLOSURES 0 -p CLPFD TRUE'

			To run ProB Tcl/Tk from sources:
			alias prob='cd $PROB_SOURCE_DIR; unlimit; sics -Dprob_profile=true -l $PROB_SOURCE_DIR/prob_tcltk.pl --goal "go."'

			To run the ProB Test REPL from sources:
			alias test='cd $PROB_SOURCE_DIR/..; rlwrap sicstus -Dprob_safe_mode=true -l $PROB_SOURCE_DIR/test_runner.pl --goal "test_repl."'