Skip to content

[Docs] Update development docs to warn to not use the changelog hook#923

Merged
h5law merged 2 commits intomainfrom
dev_docs_changelog_update
Jul 24, 2023
Merged

[Docs] Update development docs to warn to not use the changelog hook#923
h5law merged 2 commits intomainfrom
dev_docs_changelog_update

Conversation

@h5law
Copy link
Contributor

@h5law h5law commented Jul 21, 2023

Description

Summary generated by Reviewpad on 21 Jul 23 19:06 UTC

This pull request updates the README.md file in the "docs/development" directory. It includes changes to the pre-commit changelog verification and provides a note explaining that the verification has been disabled during the development of V1 in order to unblock development velocity. The patch also includes a link to more details about the change.

Issue

Fixes #<issue_number>

Type of change

Please mark the relevant option(s):

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Major breaking change
  • Documentation
  • Other

List of changes

Testing

  • make develop_test; if any code changes were made
  • make test_e2e on k8s LocalNet; if any code changes were made
  • e2e-devnet-test passes tests on DevNet; if any code was changed
  • Docker Compose LocalNet; if any major functionality was changed or introduced
  • k8s LocalNet; if any infrastructure or configuration changes were made

Required Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added, or updated, godoc format comments on touched members (see: tip.golang.org/doc/comment)
  • I have tested my changes using the available tooling
  • I have updated the corresponding CHANGELOG

If Applicable Checklist

  • I have updated the corresponding README(s); local and/or global
  • I have added tests that prove my fix is effective or that my feature works
  • I have added, or updated, mermaid.js diagrams in the corresponding README(s)
  • I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

@h5law h5law added the documentation Improvements or additions to documentation label Jul 21, 2023
@h5law h5law requested a review from Olshansk July 21, 2023 17:24
@h5law h5law self-assigned this Jul 21, 2023
@reviewpad reviewpad bot added small Pull request is small waiting-for-review docs labels Jul 21, 2023
Co-authored-by: Daniel Olshansky <olshansky@pokt.network>
@h5law h5law merged commit 128a277 into main Jul 24, 2023
@h5law h5law deleted the dev_docs_changelog_update branch July 24, 2023 10:24
red-0ne pushed a commit that referenced this pull request Aug 2, 2023
…923)

Co-authored-by: Daniel Olshansky <olshansky@pokt.network>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation Improvements or additions to documentation small Pull request is small waiting-for-review

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants