[go: up one dir, main page]

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

docs: Fix resources comments order in helm chart #508

Merged
merged 1 commit into from
May 22, 2024

Conversation

pando85
Copy link
Contributor
@pando85 pando85 commented Mar 6, 2024

Pull Request template

Please, go through these steps before you submit a PR.

Why is this PR required? What issue does it fix?:
Fix helm docs.

What this PR does?:

Does this PR require any upgrade changes?:

If the changes in this PR are manually verified, list down the scenarios covered::

Any additional information for your reviewer? :
Mention if this PR is part of any design or a continuation of previous PRs

Checklist:

  • Fixes #
  • PR Title follows the convention of <type>(<scope>): <subject>
  • Has the change log section been updated?
  • Commit has unit tests
  • Commit has integration tests
  • (Optional) Are upgrade changes included in this PR? If not, mention the issue/PR to track:
  • (Optional) If documentation changes are required, which issue on https://github.com/openebs/openebs-docs is used to track them:

PLEASE REMOVE BELOW INFORMATION BEFORE SUBMITTING

The PR title message must follow convention:
<type>(<scope>): <subject>.

Where:

  • type is defining if release will be triggering after merging submitted changes, details in CONTRIBUTING.md.
    Most common types are:

    • feat - for new features, not a new feature for build script
    • fix - for bug fixes or improvements, not a fix for build script
    • chore - changes not related to production code
    • docs - changes related to documentation
    • style - formatting, missing semi colons, linting fix etc; no significant production code changes
    • test - adding missing tests, refactoring tests; no production code change
    • refactor - refactoring production code, eg. renaming a variable or function name, there should not be any significant production code changes
  • scope is a single word that best describes where the changes fit.
    Most common scopes are like:

    • data engine (localpv, jiva, cstor)
    • feature (provisioning, backup, restore, exporter)
    • code component (api, webhook, cast, upgrade)
    • test (tests, bdd)
    • chores (version, build, log, travis)
  • subject is a single line brief description of the changes made in the pull request.

Signed-off-by: Alexander Gil <pando855@gmail.com>
@niladrih
Copy link
Member

@pando85 -- Why is this change required?

@pando85
Copy link
Contributor Author
pando85 commented Mar 22, 2024

To fix the resources key comments.

@Abhinandan-Purkait
Copy link
Member

@pando85 Can you please explain the changes in the PR description.

@pando85
Copy link
Contributor Author
pando85 commented May 22, 2024

I think that the diff is pretty clear. There are an error with the order of the commented resources values.

@Abhinandan-Purkait
Copy link
Member
Abhinandan-Purkait commented May 22, 2024

I think that the diff is pretty clear. There are an error with the order of the commented resources values.

Yeah we can see the diff. Please update that in the description. The description has no information about the PR.

@niladrih niladrih merged commit fd3afc5 into openebs:develop May 22, 2024
1 check passed
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