Skip to content

Commit

Permalink
docs: fix design handoff, add steps and change titles in processes (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
matheusps authored May 2, 2024
2 parents d9c9c49 + 9a44891 commit 22011e9
Show file tree
Hide file tree
Showing 3 changed files with 109 additions and 37 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,80 @@ Read the [processes](https://shoreline.vtex.com/guides/processes) guidelines bef

## New component

- Branch in the [Shoreline – Components](https://www.figma.com/file/PWGSQ26U55u8E34JWn9ZYE/Shoreline-%E2%80%93-Components?type=design) Figma library adding the new component with the name *Add [Component name]*, and using the [component section template](https://www.figma.com/file/1rQH2tU85kYEYRHRoAP5gZ/InnerSource-%E2%80%93-Design-Templates?type=design&node-id=5%3A6&mode=design&t=p7YfrIpPzse68e3F-1) when adding the component.
- Component structure, and library and website documentation following the [component guidelines](https://shoreline.vtex.comguides/design-contribution/component).
- Specs file using the [component handoff template](https://www.figma.com/file/1rQH2tU85kYEYRHRoAP5gZ/InnerSource-%E2%80%93-Design-Templates?type=design&node-id=5%3A6&mode=design&t=p7YfrIpPzse68e3F-1) in the Figma [Handoff Project](https://www.figma.com/files/1039547871204188270/project/222840705/%5B%F0%9F%94%92temp%5D-InnerSource-Handoffs?fuid=971115106686349023) inside the Shoreline Team.
import { Steps } from 'nextra/components'

<Steps>
### Structure and documentation

Component structure, library and website documentation following the [component guidelines](https://shoreline.vtex.comguides/design-contribution/component).

### Branch in Figma library

Create a branch in the [Shoreline – Components](https://www.figma.com/file/PWGSQ26U55u8E34JWn9ZYE/Shoreline-%E2%80%93-Components?type=design) Figma library adding the new component with the name *Add [Component name]*, and using the [component section template](https://www.figma.com/file/1rQH2tU85kYEYRHRoAP5gZ/InnerSource-%E2%80%93-Design-Templates?type=design&node-id=5%3A6&mode=design&t=p7YfrIpPzse68e3F-1) when adding the component.

### Specs file

Create a specs file using the [component handoff template](https://www.figma.com/file/1rQH2tU85kYEYRHRoAP5gZ/InnerSource-%E2%80%93-Design-Templates?type=design&node-id=5%3A6&mode=design&t=p7YfrIpPzse68e3F-1) in the Figma [Handoff Project](https://www.figma.com/files/1039547871204188270/project/222840705/%5B%F0%9F%94%92temp%5D-InnerSource-Handoffs?fuid=971115106686349023) inside the Shoreline Team.

#### How to fill in the implementation specifications?
Ask yourself which aspects of the component may cause doubts during implementation or could go unnoticed. Remember that the instructions added to the file will guide a frontend developer on how to better implement the component, so be as detailed as possible.

- Include the component name, description, and a link to the best practices and related components documentation.
- Include examples detailing the variants, specially the ones that are not exposed in the component itself.
- List anything specific to tokens usage in the component.
- Specify any element that is optional in the component.
- If the component includes icons or labels, specify if they can be replaced or if there are any restrictions.
- Include examples detailing how the elements behave when the component changes size.
- Specify the component spacing and bleed usage.
- Detail when a different cursor than the default should be displayed when overlaying an element.
- Detail when a component should have a z-index different from the applied default.
- Detail max/min or height/width, when they are applied.
- Suggest when it is possible to localize a text string in the component.

</Steps>


## New icon

<Steps>
### Structure and documentation

Icon structure and library documentation following the [icon guidelines](https://shoreline.vtex.comguides/design-contribution/icon).

### Branch in Figma library

Create a branch in the [Shoreline – Icons](https://www.figma.com/file/o3s49SJn2lIfmXBkHd9aXi/Shoreline-%E2%80%93-Icons?type=design&t=2tKhLTdmAl3dOZBm-6) Figma library adding the new icon with the name *Add [Icon name]*.

</Steps>

## Bug fix restricted to Figma

<Steps>

### Structure and documentation

Component or icon fix follows the [component](https://shoreline.vtex.comguides/design-contribution/component) or [icon](https://shoreline.vtex.comguides/design-contribution/icon) guidelines.

### Branch in Figma library

Create a branch in the [Shoreline – Icons](https://www.figma.com/file/o3s49SJn2lIfmXBkHd9aXi/Shoreline-%E2%80%93-Icons?type=design&t=2tKhLTdmAl3dOZBm-6) or [Shoreline – Components](https://www.figma.com/file/PWGSQ26U55u8E34JWn9ZYE/Shoreline-%E2%80%93-Components?type=design) Figma library including the bug fix with the name *Fix [Component or Icon]*.

</Steps>

## Bug fix that needs to be implemented

<Steps>

### Structure and documentation

- Icon structure and library documentation following the [icon guidelines](https://shoreline.vtex.comguides/design-contribution/icon).
- Branch in the [Shoreline – Icons](https://www.figma.com/file/o3s49SJn2lIfmXBkHd9aXi/Shoreline-%E2%80%93-Icons?type=design&t=2tKhLTdmAl3dOZBm-6) Figma library adding the new icon with the name *Add [Icon name]*.
Component or icon fix follows the [component](https://shoreline.vtex.comguides/design-contribution/component) or [icon](https://shoreline.vtex.comguides/design-contribution/icon) guidelines.

## Bug fix
### Branch in Figma library

### Bug restricted to Figma
Create a branch in the [Shoreline – Icons](https://www.figma.com/file/o3s49SJn2lIfmXBkHd9aXi/Shoreline-%E2%80%93-Icons?type=design&t=2tKhLTdmAl3dOZBm-6) or [Shoreline – Components](https://www.figma.com/file/PWGSQ26U55u8E34JWn9ZYE/Shoreline-%E2%80%93-Components?type=design) Figma library including the bug fix with the name *Fix [Component or Icon]*.

- Branch in the [Shoreline – Icons](https://www.figma.com/file/o3s49SJn2lIfmXBkHd9aXi/Shoreline-%E2%80%93-Icons?type=design&t=2tKhLTdmAl3dOZBm-6) or [Shoreline – Components](https://www.figma.com/file/PWGSQ26U55u8E34JWn9ZYE/Shoreline-%E2%80%93-Components?type=design) Figma library including the bug fix with the name *Fix [Component or Icon]*.
- Component or icon fix follows the [component](https://shoreline.vtex.comguides/design-contribution/component) or [icon](https://shoreline.vtex.comguides/design-contribution/icon) guidelines.
### Specs file

### Bug fix that needs to be implemented
If it is a component, follow the same [specs guidelines](https://shoreline.vtex.com/guides/design-contribution/handoff-requirements#specs-file) from a new component.

- Branch in the [Shoreline – Icons](https://www.figma.com/file/o3s49SJn2lIfmXBkHd9aXi/Shoreline-%E2%80%93-Icons?type=design&t=2tKhLTdmAl3dOZBm-6) or [Shoreline – Components](https://www.figma.com/file/PWGSQ26U55u8E34JWn9ZYE/Shoreline-%E2%80%93-Components?type=design) Figma library including the bug fix with the name *Fix [Component or Icon]*.
- Component or icon fix follows the [component](https://shoreline.vtex.comguides/design-contribution/component) or [icon](https://shoreline.vtex.comguides/design-contribution/icon) guidelines.
- If it is a component, the specs file follows the [component handoff template](https://www.figma.com/file/1rQH2tU85kYEYRHRoAP5gZ/InnerSource-%E2%80%93-Design-Templates?type=design&node-id=5%3A6&mode=design&t=p7YfrIpPzse68e3F-1) in the Figma [Handoff Project](https://www.figma.com/files/1039547871204188270/project/222840705/%5B%F0%9F%94%92temp%5D-InnerSource-Handoffs?fuid=971115106686349023) inside the Shoreline Team.
</Steps>
64 changes: 40 additions & 24 deletions packages/docs/pages/guides/processes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,19 @@ You can contribute in several ways, depending on your interest and bandwidth.
Whether you want to volunteer for existing work or just submit an idea or report
a bug, there are processes to follow. Learn about them here.

## Report a bug
## Bug report

Reporting a bug means that you’ve found a potential problem with the library, in
Figma or code, and want to share it with the community or even propose a solution
for it.

![Bug report flow](/assets/bug-report.png)

**Step 1: Open a GitHub issue in the Shoreline repository**
import { Steps } from 'nextra/components'

<Steps>

### Open a GitHub issue in the Shoreline repository

Use the [bug report template](https://github.com/vtex/shoreline/issues/new/choose) and answer important questions like what is the
context, the issue you are facing, and the evidence you have. If you already
Expand All @@ -23,13 +27,13 @@ as possible.
For bug fixes in Figma, propose a solution by creating a branch in the library
with the name _Fix [Component or Icon name]_.

**Step 2: Discussion**
### Discussion

You can get feedback through comments on the GitHub issue. Make sure to share
all the necessary information about the issue so the community can help to
understand the problem. As you make progress, make sure to update your issue.

**Step 3: Definition**
### Definition

As the discussions and refinements occur, your issue can be classified as valid to
be resolved or not. If it is valid, the issue can have three destinations.
Expand All @@ -46,9 +50,11 @@ to implement it.

After that, the issue will be tagged with the label `status: active` which means that it is ready to be resolved.

## Submit a proposal
</Steps>

Submitting a proposal means that you've already designed a solution and want to share it with the community.
## Proposal

Submitting a proposal means that you want to propose an idea, you've already designed a solution, and want to share it with the community.

![Feature proposal flow](/assets/feature-proposal.png)

Expand All @@ -62,21 +68,23 @@ yourself if you're clear on the scope of the project, if the task is feasible fo
you to do, and if you would need to collaborate with someone else. Feel free to
ask any questions!

If everything is clear, move on with submitting your proposal:
If everything is clear, move on with submitting your proposal.

<Steps>

**Step 1: Open a GitHub issue in the Shoreline repository**
### Open a GitHub issue in the Shoreline repository

Use the [proposal template](https://github.com/vtex/shoreline/issues/new/choose) and answer important questions like the problem you
are solving, your solution, and the references you had. If the proposal is
related to an existing issue, remember to mention it. Don't worry if your proposal
is not finalized yet! Share it and start a discussion as early as possible.

**Step 2: Discussion**
### Discussion

You can get feedback through comments on the GitHub issue or by attending office hours.
As you make progress, make sure to update your issue.

**Step 3: Definition**
### Definition

As the discussions and refinements occur, your issue can be classified as valid to be resolved or not.
- **If it is valid and it is a design proposal:** Prepare the handoff following
Expand All @@ -90,29 +98,32 @@ summarizing the previous one and will move it to the Shoreline Backlog.

After that, the issue will be tagged with the label `status: active` which means that it is ready to be resolved.

## Request a feature
</Steps>

Requesting a feature means that you have an idea that you want to share with the
community. You can request a feature in Figma or code.
## Feature request

Requesting a feature means that you want to suggest an enhancement to Shoreline. You can request a feature in Figma or code.

![Feature request flow](/assets/feature-request.png)

**Step 1: Open a GitHub issue in the Shoreline repository**
<Steps>

### Open a GitHub issue in the Shoreline repository

Use the [feature request](https://github.com/vtex/shoreline/issues/new/choose) template and answer important questions about the feature
like what is the context, how can we benefit from it, and the rationale behind it.
If you already have a potential solution to this issue don’t forget to share it.
Don't worry if you aren’t sure about the issue! Share it and start a discussion as early
as possible.

**Step 2: Discussion**
### Discussion

You can get feedback through comments on the GitHub issue. Make sure to share
all the necessary information about the feature so the community can help giving
insights and sharing their context as well. As you make progress, make sure to
update your issue.

**Step 3: Definition**
### Definition

As the discussions and refinements occur, your issue can be classified as valid to
be resolved or not.
Expand All @@ -130,36 +141,41 @@ After that, the issue will be tagged with the label `status: active` which means
that it is ready to be resolved. Keep in mind that when requesting a feature
the issue can be tackled by a maintainer, the community or even you.

</Steps>

## Ask a question or send a feedback
## Question & Feedback

Asking a question or sending a feedback means that you have something to share with
maintainers or the community that probably is bothering you. Feel free to reach
us anytime you need!

![Question and Feedback flow](/assets/question-feedback.png)

**Step 1: Open a GitHub issue in the Shoreline repository**
<Steps>

### Open a GitHub issue in the Shoreline repository

Use the [question template](https://github.com/vtex/shoreline/issues/new/choose) and answer important questions about your submission
like how we can help, what have you tried, and any additional information. Don't
be shy! Share it and start a discussion as early as possible.

**Step 2: Discussion**
### Discussion

You can get feedback through comments on the GitHub issue. Make sure to share
all the necessary information about the feature so the community can help giving
insights and sharing their context as well. As you make progress, make sure to
update your issue.

**Step 3: Definition**
### Definition

The idea here is that your issue act as a forum for discussion and resource for
others that might have the same question. If the issue is resolved, a maintainer
will close it.

It may be that your question or feedback can be used as a reference for a future
feature request or potential bug fix, in this case the issue will be summarized in
Your question or feedback can be used as a reference for a future
feature request or potential bug fix. In this case, the issue will be summarized in
a new one and moved to the Shoreline backlog. After that, the issue will be tagged
with the label status: active which means that it is ready to be resolved. Keep in
mind that in this case the issue can be tackled by a maintainer, the community or even you.
with the label `status: active` which means that it is ready to be resolved. Keep in
mind that in this case the issue can be tackled by a maintainer, the community or even you.

</Steps>
Binary file modified packages/docs/public/assets/feature-request.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 22011e9

Please sign in to comment.