Design Contributions

Thank you for your interest in contributing to Lyzer's design! This guide will help you understand how to contribute to the design of the application.

This can fall into two categories:

• UI/UX Design
• Architectural Design

We will cover both of these in this guide.

UI/UX Design

First and foremost, thank you for your contribution. At the stage of writing this, we are only 2 developers with limited UX experience, so we are always looking for ways to improve the application.

Making a design propsal

We do not expect designers to have to dive into git and create a PR, so please follow the following template to create a design proposal in the GitHub issues.

# Design Proposal

## Description

A clear and concise description of the design proposal.

## Screenshots/Mockups

Screenshots or mockups of the design proposal.

## Additional Context

Any other context that you think is relevant to the design proposal. Formatted however you see fit.

## Can we contact you?

In this section just let us know if we can contact you for further discussions and if you would like to be credited for your work. We believe that design is an always ongoing effort and we would love to be able to talk to you about it.

Review Process

When you open your issue, it will be reviewed by a maintainer (please do tag them in the issue).

If we need to make any changes, we will prioritize and get it resolved as soon as possible.

Architectural Design

This is where you will be able to help us design or make changes to the architecture of the application.

Making a propsal

We do not expect you to dive into git and create a PR, so please follow the following template to create a design proposal in the GitHub issues.

# Design Proposal

## Description

A clear and concise description of the design proposal.

## Benefits

A clear and concise description of the benefits of the design proposal.

## Drawbacks

A clear and concise description of the drawbacks of the design proposal. If there are no drawbacks, just say that.

## Additional Context

Any other context that you think is relevant to the design proposal. Formatted however you see fit.

We always appreciate some diagrams, so please feel free to add them to the issue.

## Can we contact you?

In this section just let us know if we can contact you for further discussions and if you would like to be credited for your work. We believe that design is an always ongoing effort and we would love to be able to talk to you about it.

Review Process

When you open your issue, it will be reviewed by a maintainer (please do tag them in the issue).

If we need to make any changes, we will prioritize and get it resolved as soon as possible.

Thank you

Thank you for taking your time to contribute to the design of the application.