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-32547 Create DevDoc Doc template #19054

Merged

Conversation

JamesDeFabia
Copy link
Contributor

@JamesDeFabia JamesDeFabia commented Aug 28, 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:

@JamesDeFabia JamesDeFabia requested a review from stuartort August 28, 2024 18:25
Copy link

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

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

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.

I would suggest creating a top level docdoc directory (call it something useful). Move this file into this directory and use it as a start point for other doc.md files

When ready add an entry to the config.js file (either as part of this PR or a future one)

@JamesDeFabia
Copy link
Contributor Author

I would suggest creating a top level docdoc directory (call it something useful). Move this file into this directory and use it as a start point for other doc.md files

@stuartort I have another pull request that creates a folder (among other files). After that PR is merged, I will edit this PR to move the file there and add a link to it from the contributor's doc.

@JamesDeFabia JamesDeFabia force-pushed the HPCC-32547DocTemplate branch from 25e21e2 to 7aef630 Compare October 16, 2024 16:25
@JamesDeFabia
Copy link
Contributor Author

@stuartort I moved the file to the devdoc/docs folder

@ghalliday ghalliday merged commit 0295637 into hpcc-systems:candidate-9.8.x Oct 18, 2024
52 checks passed
Copy link

Jirabot Action Result:
Added fix version: 9.8.32
Workflow Transition: 'Resolve issue'

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