Issues and Requests

Any issues or requests should go first to the ink channel. There you can ask about the issue, learn if it's already known or something new, and discuss change proposals with the ink team. This lets us reach an agreement on your proposal before you put significant effort into it

If you’re only fixing a bug, it’s fine to submit a pull request right away but we still recommend to ask first in the ink channel detailing what you’re fixing. This is helpful in case we don’t accept that specific fix but want to keep track of it.

When asking about a possible bug you encountered, the first thing we'll probably ask of you is a reproduction of the bug (or a reduced test case) or the screen/code where the bug is happening.

We'll then let you know if this is a known bug or if you need to create a Jira ticket for us to attend to the problem as fast as possible.

Depending on the questions you're asking we may ask for a code sample, a Playroom reproduction, a mockup or any other resources.

These requests help us understand exactly what you're trying to achieve and what's stopping you from getting there. Providing us with extra steps you took to try and fix the problem will also help us understand what is happening.

Before asking in the channel, be sure you read the documentation to the component, many questions are already answered there.

We often receive the same question multiple times so, searching the channel for your doubt sometimes can help too.

To do a request for a component or feature for a component in ink, asking in the channel before starting to code is the best approach.

There you'll know if the request is something we want to implement on our side or perhaps should be something implemented on your side. We'll also help choose the best path for your code and maybe offer to help if we have the bandwidth.

Prior to adding code to ink, read the steps on the Adding code to ink guide.

If you're asked to open a ticket on Jira, here is the easiest way to do that:

Go to the ink channel and on the left side of the text area you will find a little lightining for shortcuts:

Clicking on it, you can see that it opens several options, click on "Open a request":

On the modal that shows up, select the options that better fit your request/issue:

You'll then receive a message from the Slackbot on your slack with a link for where you can better describe your issue:

By clicking on the link provided you'll be redirected to the Jira form you'll need to fill out with your request/issue. The page will look similar to this, depending on what you chose to report:

After filling all the required fields on the form and clicking on create at the end of the page, you'll be redirected to your created ticket, where you can see the number of the ticket, its informations and any future changes that might be made with it:

Alternatively to Jira you can also open an issue on our repo and it will be automatically transformed into a Jira ticket for you.

Creating a ticket this way will automatically make it a bug, so please don't use the github issues to create requests.