Skip to content

Request a New Feature

FormerLurker edited this page Feb 22, 2020 · 2 revisions

UNDER CONSTRUCTION This page is still under construction. Things will change here a lot over the next days and weeks, so be sure to keep checking in!

Have an idea for a cool new octolapse feature? Are you using a slicer that is not currently supported by Octolapse? Is your printer not listed in the Make/Model dropdown in the Octolapse printer profile page? If the answer is yes to any of these questions, you may want to create a feature request.

To best explain your idea, please follow the suggestions below for creating a new feature request.

Add [Request] to your issue title

A good feature request issue title might be: [Request] Printer profile for SuperPrinter Version 5

Using the [Request] prefix makes it easy to sort bug reports from new features/enhancements. This is very useful for me and for other users of the issues pages.

Be descriptive

Give me as much info as possible. If I can't tell what you are asking for, I'll just have to ask you to clarify, and that will make things more more slowly.

For example if you want support a new slicer or printer, make sure you include the as much info about it as possible (make/model/version, for example). Include links to the manufacturer/developer's pages. Sample gcode files, photos, videos, notes, or anything else that can clarify what you are requesting will be helpful.

Scrennshots, drawings, or pseudocode would be useful if you want some kind of change to Octolapse itself. If you are a developer and want to interface with Octolapse, a link to your source code would be helpful as well.

Upload your files to gist.github.com

If you are attaching large documents or text files to your request, please please use gist.github.com. It's fast, convenient, and extremely useful for me. Pasting long log entries or gcode files (very short snippets are fine, but NOT long ones) directly in the github issue makes it very difficult for me to examine your issue. If I'm on mobile it makes it nearly impossible. Also, many file upload services are slow and many of the free ones can be virus infested.

That being said there are cases where using a different system is OK, but they are pretty rare. When in doubt, just create a gist.

Be patient and understanding

Some features take months or years to develop, even if they sound simple. I've gotten requests for features that I've REALLY wanted to add, but decided not to for a multitude of reasons. If your feature request is sitting on the back burner, it means I'm considering adding it at some point. If I remove a feature request, it probably wasn't easy for me to do so. These decisions are not easy, and not every feature request will be added. Some will even be removed. Besides, Octolapse is open-source, so it is always possible to add any feature imaginable as long as someone can implement it.

Request the feature already

Now you are ready to create your feature request! Try it out here!

Clone this wiki locally