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

Jump to bottom

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

wants to merge 2 commits into from

Conversation

cloLN
Copy link
Contributor

@cloLN cloLN commented Sep 16, 2024

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

@cloLN cloLN requested a review from stuartort September 16, 2024 17:52
@github-actions GitHub Actions
Copy link

Jira Issue: https://hpccsystems.atlassian.net//browse/HPCC-29356

Jirabot Action Result:
Workflow Transition To: Merge Pending
Updated PR

stuartort
stuartort approved these changes Sep 16, 2024
View reviewed changes
Copy link
Member

@stuartort stuartort left a comment

Choose a reason for hiding this comment

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

This addition looks fine

ghalliday
ghalliday reviewed Sep 25, 2024
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

Looks good. Please remove adding core files. I'm happy for you to leave the rest as it is.

devdoc/userdoc/JiraGuidelines.md Outdated
- 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.
Copy link
Member

Choose a reason for hiding this comment

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

I don't think we generally want core files attached - they may contain pii, and can be GBs in size.

devdoc/userdoc/JiraGuidelines.md Outdated
- Build version of the environment you're using.
- URL to environment.
- URL to workunit.
- Which browser and its version.
Copy link
Member

Choose a reason for hiding this comment

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

would it be worth grouping this with screenshot under user-interface issues?

@ghalliday
Copy link
Member

@cloLN this is waiting for you to update it...

@cloLN
HPCC-29356 Update JiraGuidelines.md based on review
bdb9c48 
 - Created section for User Interface type issues.
 - Removed references to core file and added warning of potential PII
ghalliday
ghalliday reviewed Nov 11, 2024
View reviewed changes
devdoc/userdoc/JiraGuidelines.md
- 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.

@ghalliday
Copy link
Member

@cloLN this is still waiting for you...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ghalliday ghalliday ghalliday left review comments

@stuartort stuartort stuartort approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@cloLN @ghalliday @stuartort