First, ensure you have signed a contributor license agreement. Then follow these steps for contributing to Lisp-Stat:
- Step 1: Get source code.
- Step 2: Get approval and modify the source code.
- Step 3: Get your code reviewed and committed to the project.
You may also be interested in the additional information at the end of this document.
Get source code
First you need the Lisp-Stat source code. The core systems are found on the Lisp-Stat github page. For the individual systems, just check out the one you are interested in. For the entire Lisp-Stat system, at a minimum you will need:
Other dependencies will be pulled in by Quicklisp.
Development occurs on the “master” branch. To get all the repos, you can use the following command in the directory you want to be your top level dev space:
git clone https://github.com/Lisp-Stat/data-frame.git && \ git clone https://github.com/Lisp-Stat/dfio.git && \ git clone https://github.com/Lisp-Stat/special-functions.git && \ git clone https://github.com/Lisp-Stat/numerical-utilities.git && \ git clone https://github.com/Lisp-Stat/documentation.git && \ git clone https://github.com/Lisp-Stat/lisp-stat.git && \ git clone https://github.com/Lisp-Stat/plot.git && \ git clone https://github.com/Lisp-Stat/select.git && \ git clone https://github.com/Lisp-Stat/array-operations.git
Modify the source
Before you start, send a message to the Lisp-Stat mailing list or file an issue on Github describing your proposed changes. Doing this helps to verify that your changes will work with what others are doing and have planned for the project. Importantly, there may be some existing code or design work for you to leverage that is not yet published, and we’d hate to see work duplicated unnecessarily.
Be patient, it may take folks a while to understand your requirements. For large systems or design changes, a design document is preferred. For small changes, issues and the mailing list are fine.
Once your suggested changes are agreed, you can modify the source code and add some features using your favorite IDE.
The following sections provide tips for working on the project:
Please consider the following before submitting a pull request:
- Code should be formatted according to the Google Common Lisp Style Guide
- All code should include unit tests. Currently we use fiveam as the test framework for new projects, but are looking at Parachute and Rove as more extensible alternatives.
- Contributions should pass existing unit tests
- New unit tests should be provided to demonstrate bugs and fixes
- Indentation in Common Lisp is important for readability. Contributions should adhere to these guidelines. For the most part, a properly configured Emacs will do this automatically.
Github includes code review tools that can be used as part of a pull request. We recommend using a triangular workflow and feature/bug branches in your own repository to work from. Once you submit a pull request, one of the committers will review it and possibly request modifications.
As a contributor you should organise (squash) your git commits to make them understandable to reviewers:
- Combine WIP and other small commits together.
- Address multiple issues, for smaller bug fixes or enhancements, with a single commit.
- Use separate commits to allow efficient review, separating out formatting changes or simple refactoring from core changes or additions.
- Rebase this chain of commits on top of the current master
- Write a good git commit message
Once all the comments in the review have been addressed, a Lisp-Stat committer completes the following steps to commit the patch:
- If the master branch has moved forward since the review, rebase the branch from the pull request on the latest master and re-run tests.
- If all tests pass, the committer amends the last commit message in the series to include “this closes #1234”. This can be done with interactive rebase. When on the branch issue:
git rebase -i HEAD^
- Change where it says “pick” on the line with the last commit, replacing it with “r” or “reword”. It replays the commit giving you the opportunity the change the commit message.
- The committer pushes the commit(s) to the github repo
- The committer resolves the issue with a message like
"Fixed in <Git commit SHA>".
Where to start?
If you are new to statistics or Lisp, documentation updates are always a good place to start. You will become familiar with the workflow, learn how the code functions and generally become better acquainted with how Lisp-Stat operates. Besides, any contribution will require documentation updates, so it’s good to learn this system first.
If you are coming from an existing statistical environment, consider porting a XLispStat package that you find useful to Lisp-Stat. Use the XLS compatibility layer to help. If there is a function missing in XLS, raise an issue and we’ll create it. Some XLispStat code to browse:
- XLispStat archive
- XLispStat source
- The following are built on XLispStat:
Keep in mind that some of these rely on the XLispStat graphics system, which was native to the platform. LISP-STAT uses Vega for visualizations, so there isn’t a direct mapping. Non-graphical code should be a straight forward port.
You could also look at CRAN, which contains thousands of high-quality packages.
For specific ideas that would help, see the ideas page.
Please comment on issues in github, making your concerns known. Please also vote for issues that are a high priority for you.
Please refrain from editing descriptions and comments if possible, as edits spam the mailing list and clutter the audit trails, which is otherwise very useful. Instead, preview descriptions and comments using the preview button (on the right) before posting them. Keep descriptions brief and save more elaborate proposals for comments, since descriptions are included in GitHub automatically sent messages. If you change your mind, note this in a new comment, rather than editing an older comment. The issue should preserve this history of the discussion.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.