When to the Bintracker source, please follow the rules laid out in this style guide. This will help keep the source neat and readable for everyone.
- Put the highest abstractions at the end of the file/section. Define the dependencies of a definition before that definition whenever possible.
- Avoid large procedures. Consider breaking up procedures that exceed 35 lines of code.
- Use a maximum of 80 characters per line.
- Always break after closing parens.
- Follow common formatting guidelines for Scheme. See SchemeWiki for a short overview. Note that the Bintracker source frequently ignores SchemeWiki's Rule 4, but please do respect it in new code.
We recommend using an editor that supports structural editing (aka paredit), such as Emacs, Vim, Sublime Text, VS Code, or Atom. This doesn't just help to avoid syntax errors, but also will ensure reasonable formatting defaults.
- Names should be lowercase, with hyphens to separate words, eg.
- Bindings exported from plugins must be prefixed with the plugin-id followed by two colons, eg.
- Follow the common Scheme naming conventions, eg.
foo? ;; this is a predicate
foo->bar ;; this is a converter that takes a 'foo and returns a 'bar
foo-set! ;; this is a mutator
- Be verbose. Use descriptive names. Avoid abbreviations, except in cases where the meaning is completely obvious.
- Do not use
ifforms without an else clause. Use
wheninstead to return undefined value on failure.
We encourage developers to document code extensively in-source.
Bintracker uses scm2wiki to generate API documentation from its source files. Scm2wiki picks up source comments prefixed with
;;; (3 semicolons), and adds them to the HTML documentation. If a comment occurs directly before a definition, scm2wiki will automatically prepend a definition header. Document all exported symbols in this way.