Contributing

Reporting issues

At this time, the most useful thing you can do to help is and useful bug reports to the Issue Tracker

In your report, please discuss what you wanted to happen as well as what happened. Also, please include enough information to reproduce the issue.

Please include at least the version of turtles you’re using and the version of Emacs you’re running, taken, for example, from M-x about-emacs.

Suggesting features

Please add feature suggestions to the Issue Tracker or start a discussion.

Asking questions

Start a discussion with your question.

Code contributions

To contribute code to the project, open a Pull Request targeted to the dev branch.

Before you do that, make sure the any new features is covered by tests and that the tests pass.

To run the tests, install and setup eldev, then run eldev test.

Tests can also be run from inside of Emacs, using M-x ert-run-tests-interactively but when you do so, be aware that there might be unexpected interaction with your Emacs configurations. The tests passing reliably when run using eldev test is what matters.

Please also make sure your commit message follows Conventional Commits 1.0.0, in short, the commit message of new features should start with “feat: “, fixes with “fix: “, refactorings with “refactor: ” and tests with “test: “.

Documentation contributions

You don’t need to be a developer to contribute! Contribution to the documentation or code comments are very welcome. Please open a Pull Request targeting the master branch with your proposed modifications. To follow Conventional Commits 1.0.0, the commit message should start with “docs: “

The documentation is written in reStructuredText. You’ll need to install Sphinx to build it:

python3 -m venv venv
. venv/bin/activate # or activate.fish on fish
pip3 install -r docs/requirements.txt

Then run eldev html or eldev build turtles.info to build the documentation.