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.

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-32862 Add Copilot article to devdoc #19229

Open
wants to merge 1 commit into
base: candidate-9.8.x
Choose a base branch
from

Conversation

JamesDeFabia
Copy link
Contributor

@JamesDeFabia JamesDeFabia commented Oct 23, 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:

Copy link

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

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

Copy link
Member

@g-pan g-pan left a comment

Choose a reason for hiding this comment

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

reviewed and approved

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.

Your examples are good but simple 1 line prompts. These are good when using the interactive mode in file. Developers may find it easier to use the copilot chat inside of vscode to type long detailed instructions for code development. This can be added either in this PR or create a jira (mention it here) and do it in another PR

In addition, you should probably discuss tips for saving prompts. Once you use a prompt in a code window, it is gone. In chat windows it may be saved but still a good idea to save it in another file (you never know when you get code generated, hand edit it and mess it up. It is great when you have the prompt available to regenerate your code


These prompts are more focused and are meant to accomplish a specific purpose. They are included here to spark your imagination.

If you think of others that could be included here to share witht he world, please send your ideas to <[email protected]>.
Copy link
Member

Choose a reason for hiding this comment

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

spelling witht he -> with the

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed the typo. Creating a Jira to enhance this article with tips to save prompt history and other enhacements

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants