CONTRIBUTING.org

Contributing to this Project

I created this project based on my own needs and desires, and I’m mildly stunned that others are interested enough in creating demonstrations in Emacs, so I definitely want to work with others on this. So… contributions are always welcome, no matter how large or small. This file contains the guidelines I ask all contributors to follow.

• For any contributions to my experimental v2 track, please create a topic branch based off that v2 branch, push said topic branch onto your fork and submit your pull request from that branch.
• Wanna contribute a bug fix to my primary 1.x track, please create a topic branch based off our master branch, push said topic branch onto your fork and submit your pull request from that branch.

Code of Conduct

I want to keep this project open and inclusive. So I ask that before you contribute, you read and follow our Code of Conduct.

Found an Issue?

I definitely want to hear from you!

If you find a bug in the source code or a mistake in the docs, you can help me by submitting an issue to the repository.

Want to contribute with a fix? Thank you. Please, submit a pull request.

Want a Feature? Similarly to finding an issue, enter details for a feature request, but feel free to fork this repository and try to give me more details with pull request.

Note: While the unit tests are hardly sufficient, please make sure your PR doesn’t break any. Better yet, add more to that!

Developing

As you can imagine, testing this code is difficult to automate. Some tests for state-less functions can be found in demo-it-tests.el.

Since the base demo-it.el code is now broken into multiple subfiles, issuing a (require) won’t work without the following:

(add-to-list 'load-path (expand-file-name "."))