Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

HPCC-29356 add JIRA creation guidelines to userdocs #19123

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

HPCC-29356 add JIRA creation guidelines to userdocs #19123

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e6dce1
HPCC-29356 add JIRA creation guidelines to userdocs
cloLN Sep 16, 2024
bdb9c48
HPCC-29356 Update JiraGuidelines.md based on review
cloLN Nov 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions devdoc/userdoc/JiraGuidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
This is a guide to the type of information that is desired in JIRA tickets.

# For bugs / improvement requests on any existing features or docs:
- Provide a screenshot when it’s applicable. Not just of the offending line or excerpt, but of the entire application window.
- This is especially true for issues related to ECL Watch.
- User-Interface Issues:
- Provide a screenshot when it’s applicable. Not just of the offending line or excerpt, but of the entire application window.
- URL to environment.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

url to environment and workunit are relevant to all issues.

Which browser and version is only relevant to UI.

- URL to workunit.
- Which browser and its version.
- Provide a zap file if there is one.
- Build version of the environment you're using.
- URL to environment.
- URL to workunit.
- Which browser and its version.
- Steps for reproducing.
- Laid out in an easy to understand format.
- Either a numbered set of steps or even something simple as:
Expand All @@ -24,8 +24,8 @@ This is a guide to the type of information that is desired in JIRA tickets.
- Virtual Box
- Steps taken to install the platform if this is related to installation and init.
- If this is a bare-metal build, where did you get your package and what is the md5sum of this package?
- Include stack traces and a copy of the core file if possible.
- It could be that the core file is too big to be uploaded so either a link to core file would suffice.
- Include stack traces if possible.
- Core files can potentially contain PII so refrain from including these in the ticket.
- Ensure that there's no Personally Identifiable Information in the ticket.

# For new features, the reporter should provide in detail:
Expand Down
Loading