Skip to content

Latest commit

 

History

History
264 lines (204 loc) · 13.1 KB

CONTRIBUTING.md

File metadata and controls

264 lines (204 loc) · 13.1 KB
Raw

Contribution Guidelines

This document outlines what you need to know before creating tickets or creating pull requests.

Contents

Issues, Tickets, however you may call them

Please read the following short instructions fully and follow them. You can help the project tremendously this way: not only do you help the maintainers to address problems in a timely manner but also keep it possible for them to fix bugs, add new and improve on existing functionality instead of doing nothing but ticket management.

Ticket flow chart

  • Read the FAQ
  • If you want to report a bug, read "How to file a bug report" below and use the provided template. You do not need to do anything else with your ticket.
  • If you want to post a request of any kind (feature request, documentation request, ...), add [Request] to your issue's title (e.g. [Request] Awesome new feature).
  • If you are a developer that wants to brainstorm a pull request or possible changes to the plugin system, add [Brainstorming] to your issue's title (e.g. [Brainstorming] New plugin hook for doing some cool stuff).
  • If you need support, have a question or some other reason that doesn't fit any of the above categories, the issue tracker is not the right place. Consult the Mailinglist or the Google+ Community instead.

No matter what kind of ticket you create, never mix two or more "ticket reasons" into one ticket: One ticket per bug, request, brainstorming thread please.

Note: A bot is in place that monitors new tickets, automatically categorizes them and checks new bug reports for usage of the provided template. That bot will only bother you if you open a ticket that appears to be a bug (no [Request] or [Brainstorming] in the title) without the template, and it will do that only to ensure that all information needed to solve the issue is available for the maintainers to directly start tackling that problem.

How to file a bug report

If you encounter an issue with OctoPrint, you are welcome to submit a bug report.

Before you do that for the first time though please take a moment to read the following section completely. Thank you! :)

What should I do before submitting a bug report?

  1. Make sure you are at the right location. This is the Github repository of the official version of OctoPrint, which is the 3D print server and corresponding web interface itself.

    This is not the Github respository of OctoPi, which is the preconfigured Raspberry Pi image including OctoPrint among other things - that one can be found here. Please note that while we do have some entries regarding OctoPi in the FAQ, any bugs should be reported in the proper bug tracker which - again - is not here.

    This is also not the Github repository of any OctoPrint Plugins you might have installed. Report any issues with those in their corresponding bug tracker (probably linked to from the plugin's homepage).

    Finally, this is also not the right issue tracker if you are running an forked version of OctoPrint. Seek help for such unofficial versions from the people maintaining them instead.

  2. Please make sure to test out the current version of OctoPrint to see whether the problem you are encountering still exists.

    If you are feeling up to it you might also want to try the current development version of OctoPrint (if you aren't already). Refer to the FAQ for information on how to do this.

  3. The problem still exists? Then please look through the existing tickets (use the search) to check if there already exists a report of the issue you are encountering. Sorting through duplicates of the same issue sometimes causes more work than fixing it. Take the time to filter through possible duplicates and be really sure that your problem definitely is a new one. Try more than one search query (e.g. do not only search for "webcam" if you happen to run into an issue with your webcam, also search for "timelapse" etc).

What should I include in a bug report?

Always use the following template (you can remove what's within [...], that's only provided here as some additional information for you):

#### What were you doing?

[Please be as specific as possible here. The maintainers will need to reproduce
your issue in order to fix it and that is not possible if they don't know
what you did to get it to happen in the first place. If you encountered
a problem with specific files of any sorts, make sure to also include a link to a file
with which to reproduce the problem.]

#### What did you expect to happen?

#### What happened instead?

#### Branch & Commit or Version of OctoPrint

[Can be found in the lower left corner of the web interface.]

#### Printer model & used firmware incl. version

[If applicable, always include if unsure.]

#### Browser and Version of Browser, Operating System running Browser

[If applicable, always include if unsure.]

#### Link to octoprint.log

[On gist.github.com or pastebin.com. Always include and never truncate.]

#### Link to contents of terminal tab or serial.log

[On gist.github.com or pastebin.com. If applicable, always include if unsure or
reporting communication issues. Never truncate.]

#### Link to contents of Javascript console in the browser

[On gist.github.com or pastebin.com or alternatively a screenshot. If applicable -
always include if unsure or reporting UI issues.]

#### Screenshot(s) showing the problem:

[If applicable. Always include if unsure or reporting UI issues.]

I have read the FAQ.

Where can I find which version and branch I'm on?

You can find out all of them by taking a look into the lower left corner of the OctoPrint UI:

Current version and git branch info in OctoPrint's UI

If you don't have access to the UI you can find out that information via the command line as well. Either octoprint --version or python setup.py version in OctoPrint's folder will tell you the version of OctoPrint you are running (note: if it doesn't then you are running a version older than 1.1.0, upgrade now). A git branch in your OctoPrint installation folder will mark the branch you are on with a little *. git rev-parse HEAD will tell you the current commit.

Where can I find those log files you keep talking about?

OctoPrint by default provides two log outputs, a third one can be enabled if more information is needed.

One is contained in the "Terminal" tab within OctoPrint's UI and is a log of the last 300 lines of communication with the printer. Please copy-paste this somewhere (disable auto scroll to make copying the contents easier) - e.g. http://pastebin.com or http://gist.github.com - and include a link in your bug report.

There is also OctoPrint's application log file or in short octoprint.log, which is by default located at ~/.octoprint/logs/octoprint.log on Linux, %APPDATA%\OctoPrint\logs\octoprint.log on Windows and ~/Library/Application Support/OctoPrint/logs/octoprint.log on MacOS. Please copy-paste this to pastebin or gist as well and include a link in your bug report.

It might happen that you are asked to provide a more thorough log of the communication with the printer if you haven't already done so, the serial.log. This is not written by default due to performance reasons, but you can enable it in the settings dialog. After enabling that log, please reproduce the problem again (connect to the printer, do whatever triggers it), then copy-paste ~/.octoprint/logs/serial.log (Windows: %APPDATA%\OctoPrint\logs\serial.log, MacOS: ~/Library/Application Support/OctoPrint/logs/serial.log) to pastebin or gist and include the link in the bug report.

You might also be asked to provide a log with an increased log level. You can find information on how to do just that in the docs.

Where can I find my browser's error console?

See How to open the Javascript Console in different browsers

Pull requests

  1. If you want to add a new feature to OctoPrint, please always first consider if it wouldn't be better suited for a plugin. As a general rule of thumb, any feature that is only of interest to a small sub group should be moved into a plugin. If the current plugin system doesn't allow you to implement your feature as a plugin, create a "Brainstorming" ticket to get the discussion going on how best to solve this in OctoPrint's plugin system - maybe that's the actual PR you have been waiting for to contribute :)
  2. If you plan to make any large changes to the code or appearance, please open a "Brainstorming" ticket first so that we can determine if it's a good time for your specific pull request. It might be that we're currently in the process of making heavy changes to the code locations you'd target as well, or your approach doesn't fit the general "project vision", and that would just cause unnecessary work and frustration for everyone or possibly get the PR rejected.
  3. Create your pull request from a custom branch on your end (e.g. dev/myNewFeature)[1] against the devel branch. Create one pull request per feature/bug fix. If your PR contains an important bug fix, we will make sure to backport it to the maintenance branch to also include it in the next release.
  4. Make sure you follow the current coding style. This means:
    • Tabs instead of spaces in the Python files[2]
    • Spaces instead of tabs in the Javascript sources
    • English language (code, variables, comments, ...)
    • Comments where necessary: Tell why the code does something like it does it, structure your code
    • Following the general architecture If your PR needs to make changes to the Stylesheets, change the .less files from which the CSS is compiled.
  5. Test your changes thoroughly. That also means testing with usage scenarios you don't normally use, e.g. if you only use access control, test without and vice versa. If you only test with your printer, test with the virtual printer and vice versa. State in your pull request how your tested your changes. Ideally add unit tests - OctoPrint severly lacks in that department, but we are trying to change that, so any new code already covered with a test suite helps a lot!
  6. In your pull request's description, state what your pull request is doing, as in, what feature does it implement, what bug does it fix. The more thoroughly you explain your intent behind the PR here, the higher the chances it will get merged fast.
  7. Important: Don't forget to add yourself to the AUTHORS file :)

History

  • 2015-01-23: More guidelines for creating pull requests, support/questions redirected to Mailinglist/G+ community
  • 2015-01-27: Added another explicit link to the FAQ
  • 2015-07-07: Added step to add yourself to AUTHORS when creating a PR :)
  • 2015-12-01: Heavily reworked to include examples, better structure and all information in one document.

Footnotes

  • [1] - If you are wondering why, the problem is that anything that you add to your PR's branch will also become part of your PR, so if you create a PR from your version of devel chances are high you'll add changes to the PR that do not belong to the PR.
  • [2] - Yes, we know that this goes against PEP-8. OctoPrint started out as a fork of Cura and hence stuck to the coding style found therein. Changing it now would make the history and especially git blame completely unusable, so for now we'll have to deal with it (this decision might be revisited in the future).