How to suggest a new idea

This page describes what should be provided to suggest a new idea. You don't have to answer all questions, just give the more information you have. This page is a reminder for developers so that they do not forget any key points.

>>> import this
The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.
In the face of ambiguity, refuse the temptation to guess.
There should be one-- and preferably only one --obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than *right* now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea -- let's do more of those!

Specify your idea

General purpose

It is important to explain your idea in a few sentences.

Who?

  • Who will use it?
  • Does it concern all users? only new users? power users?
  • May it disturb other users ?

What?

  • What does it do?
  • Is it a new independent feature?
  • Does it replace something?
  • Does it change something?

How?

User interface

  • Is it visible?
  • What are the steps implied by this idea ?
  • How many new pages are required?
  • Does it require to modify the layout? an existing page?
  • Warnings ?
  • Notifications ?
  • Pop-up?
  • Forms ?

If possible, please provide mockups, screenshots, texts, etc.

Is it optional?

Existing implementations

  • Does another software implement this idea?
    • Is it a PLM ?

Security and permissions

  • Visibility of contents ? all users ? anonymous users? restricted accounts?
  • Contributors ? Groups ?

Errors

Here be dragons!

  • Which errors a user may make?
  • How OpenPLM should handle them?
  • Which errors may occurs independently of the user? For example:
    • broken connection
    • time-out
  • If an error occurs, should the process be completely aborted ?
  • Should the admins be warned ?
  • Is it possible to recovery from these errors ?
  • Can several errors happen at the same time ?

Examples

Example help other users/developers to understand your idea, and so, they are welcomed.

Implementation

If you want to implement a new idea, here are some points you should check.

New dependencies

  • New required dependencies ? (Python and JavaScript?)
  • New optional dependencies ?
  • Are they stable ?
  • Are they easily installable ? package ? pip? compilation ?
  • Are they licensed under a license compatible with the GPLv3 ?
  • Are they well documented? tested?

Specifications, standards

  • Is there an existing specification or standard related to this idea?
  • Does your implementation conform to these standards ?

Database

  • New models ?
  • New attributes to existing models ?
  • Removed/changed attributes ?
  • Migrations ?

Files

  • Additional files stored by OpenPLM ?
  • Served by Apache ?

Documentation

  • User documentation ? -> the most important one !
  • Admin documentation ?
    • INSTALLED_APPS ?
    • migrations ?
    • dependencies ?
    • settings ?
  • Developer documentation ?

Settings

  • New required settings ?
  • New optional settings ? Default values ?

Application

  • Can it be implemented as a django application?
    • If yes, is this application optional?

Performances

Compatibility

Tests

You should write them and explain manual test cases.