Skip to content
/ issue Public

Repository for issue tracking across this organization

Notifications You must be signed in to change notification settings

Mee-Repo/issue

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

This repository centralizes issue tracking for Mee

Intro

Is it your first issue on GitHub? Please, spare 30 minutes of your time and these references before you continue.

Ready to report an issue?

Before submitting it, make sure the problem has not been reported yet. Duplicates cost valuable time from development, user experience and customer success.

If indeed it is something worth reporting, the next step is to open the Issue Tracker and classify as:

  • [Bug](###It's a Bug), when something broke or malfunctioned
  • [Enhancement](###It's an Enhancement), when you think of an improvement to something already working

It's a Bug

Make sure you can explain the steps to reproduce the problem, then start creating an issue with the "Bug report" template. Observe that styling with Markdown is supported. And mostly enforced by the template itself. Wanna see a good bug report example? Check this.

About the template:

  1. Description is a clear and concise description of what the bug is. If applicable, add screenshots to help explain the problem. Make sure what you have written down is put in a way that others can understand too. The reader will be in another context!
    1. How to reproduce will contain a step-by-step explanation about how to reproduce the issue. We recommend listing the steps with markdown. If necessary, include the URL, that text that was on your's browser's address bar when the issue happened
    2. Expected Behaviour is a clear and concise description of what you expected to happen.
  2. Environment details helps you communicating to other testers and developers some prerequisites to reproduce the issue, such as browser and device type. Most of this information is already generated by Mee for you, on the browser console. Need more instructions? Read the next title.

How to get environment details

  1. Open the browser console while navigating on the page that has the issue you observed
  2. Find the code in [this image](##### Code you need to copy). You may need to scroll the console up
  3. Copy the code, it is just a markdown table
  4. Paste on the issue and fill any not pre-filled fields. [Check these examples of possible values](##### Fields)
Code you need to copy

the console

Fields
environment data
hostname [e.g test.mee.cc, mee.cc]
mode [e.g. production, development]
build time [e.g. 2020-05-27T21:39:22.581Z]
app version [e.g. 1.0.0-setup.0]
commit [e.g. b931f9e47fec37a2be226785032b4d0139c98de7]
device type [e.g. Laptop Computer, iPhone XR]
os [e.g. iOS]
os version [e.g. 13.5]
browser [e.g. chrome, safari]
browser ver. [e.g. Versão 81.0.4044.138 (Versão oficial) 64 bits]

It's an Enhancement

Make sure you can explain the enhancement, then start creating an issue without a template. Don't forget to add the "Enhancement" label and to assert what you have written down is put in a way that others can understand too. The reader will be in another context!

References

  1. GitHub Guides: Mastering Issues
  2. GitHub Guides: Mastering Markdown
  3. ZenHub: Taking your GitHub issues from good to great

You're a developer and want to reference an issue?

Read this quote from Creating an issues-only repository:

For example, if you pushed a commit to the private repository's default branch with a message that read Fixes organization/public-repo#12, the issue would be closed, but only users with the proper permissions would see the cross-repository reference indicating the commit that closed the issue. Without the permissions, a reference still appears, but the details are omitted.

About

Repository for issue tracking across this organization

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published