Meshery Contributing Guidelines
These guidelines are a collection of principles and conventions that need to be followed while designing mesheryctl commands.
1. Consistency is quality.
- Consistency of interaction drives a *quality* user experience. Whether that experience is delightful or painful is a related, but separate consideration. Meshery’s behavior of user interactions should be consistent even when their user experience is poor.
2. Intuitive user experiences feel natural to users.
- When being designed, each of Meshery’s user experiences should be examined first from the user’s perspective.
Commands should be designed in such a way that they are intuitive. Users should ideally be able to understand what a command is used for without having to extensively go through the documentation.
mesheryctl pattern apply -f <pattern name> requires no further clarification as it is evident that the command will apply the pattern specified.
Consistency is key when designing intuitive interfaces. Although
mesheryctl perf run -f <performance profile name> may sound more intuitive, users who are experienced in using the CLI will prefer the consistant verb
This will also ensure a consistent command language making memorizing easier.
Consistency should also be enforced when chaining commands and using flags.
For example, if
mesheryctl pattern has a
view command and has an
--output flag, then, similar commands like
mesheryctl perf should also support the same commands and flags and provide a consistent user experience.
Rational defaults overriden with flags
Default behaviour should be optimised for what users will need to do most of the time.
These assumed defaults should be easily overriden by the user with flags.
mesheryctl system context create <context name> assumes a default platform for the created context. But this can be easily overriden with the
User Experience: GUI vs CLI
Ideally, all functionality provided in Meshery UI should be available to users via CLI (in
mesherctl). Meshery strives for parity of functionality between it’s two clients. For example, viewing a performance profile in the GUI and with
mesheryctl system perf view <profile name> in the CLI should show the same data.
Command line interfaces offer less context to the user, which makes them inherently less intuitive compared to graphical user interfaces. Both of these user interfaces, however, are the same in that they are both clients of Meshery Server. Both clients are a user experience and as such, to be attended to in this way. The following considerations should be accounted for when designing
- Provide only relevant output. Use “debug” logs that can be accessed with
--verboseflag wherever needed.
- Add headers to output to give context to the user.
- As mentioned above, similar commands should behave similarly.
- Confirm steps for risky commands. For example, use the
AskForConfirmationfunction which will prompt the user to type in “yes” or “no” to continue.
- Anticipate user actions. If the user creates a new context with
mesheryctl system context createthen the next action might be
mesheryctl system startto start Meshery ot
mesheryctl system context switchto switch context names.
- Anticipate user errors. For example, if the user types in
mesheryctl system satrt, using the inbuilt features with the cobra library, we can correct it to
startand alert the user.
When designing for the CLI, consider:
What the command does
What makes sense to do from a terminal? What doesn’t? What might people want to automate? What is the default behavior? What flags might you need to change that behavior? What might people try and fail to do and how can you anticipate that?
What the command is called
What should be the command language? (
mesheryctl <command> <subcommand> [args] [flags] [value])
What should be a command vs a flag?
How can you align the language of the new command with the existing commands?
What the command outputs
How can you make the GUI and the CLI outputs similar? What should be outputted normally and what falls into debug logs?
How you explain your command
You will need to provide a short and long description of the command for the help pages and also for the Meshery Documentation.
Creating design specifications
If you are working on a new command or adding a new feature on an existing command, it is recommended to setup a design spec so that other contributors can weigh in on the design before you start to code.
Broader features should have a design spec made in Google Doc using this template.
- Contributing to Meshery Server
- Contributing to Meshery UI
- Contributing to Meshery using git
- How to write MeshKit compatible errors
- Contributing to Meshery Docs
- Contributing to Meshery CLI
- Contributing to Meshery Adapters