How to file new issues

Although we welcome anyone to file issues using the issue tracker on Github, most users will be more comfortable using the CellProfiler forum to ask for help and report issues. We monitor the forum and may be able to help you find a workaround for the problem. We might file a bug report on your behalf and include all necessary technical information.

If you file a Github issue, please attach sufficient information to reproduce the bug. For many bugs, you will need to attach a CellProfiler pipeline and the images needed to run it.

Issue labels

Issues are categorized using labels. Issue labels help us know what to work on next, or figure out how long an issue will take to solve. Here's what our labels mean:

• Bug: Something is wrong with CellProfiler, and it should be fixed. Bugs are reproducible errors or unexpected behavior. Some bugs can be fixed in an afternoon while others take longer. Please work with us to diagnose your error so we can reach a correct solution.
• Documentation: CellProfiler's documentation is a work in progress and can always be improved. Documentation fixes include providing correct information, clarifying module behavior, or fixing typos. We encourage all biologists to help improve CellProfiler documentation.
• Easy: These are issues we think amount to changing a few lines of code. These are good first issues for someone who wants to get their feet wet with a little programming. And we're happy to help!
• Enhancement: These are improvements to existing CellProfiler functionality, such as proposals for sane defaults. Usually it does not take much time or lines of code to implement an enhancement.
• Feature request: New functionality proposed to CellProfiler is assigned this label. Feature requests are generally more involved than enhancements. When a feature request is submitted, we will decide whether or not it will be added to the project. Please prepare to be engaged in the discussion!
• Needs verification: We need to verify the behavior being described in the issue. Verifiable behavior will usually be labeled as a bug.