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

Update docs to reflect segwit support in Stacks 2.1 #5480

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Pearltechie
Copy link

@Pearltechie Pearltechie commented Nov 19, 2024

Description: This pull request updates the documentation regarding Segwit address support in the Stacks project. The current documentation stated that "It cannot be a native Segwit address," which was accurate before Stacks 2.1. However, with the release of Stacks 2.1, native Segwit addresses are now supported, and this change has been reflected in the documentation.

Applicable issues

N/A

The statement "It cannot be a native Segwit address" was incorrect after Stacks 2.1. It is now corrected to reflect the current capabilities.

Additional info (benefits, drawbacks, caveats)

This change ensures the documentation accurately reflects the capabilities of Stacks 2.1, providing clarity for developers using Segwit addresses.

Checklist

  • My code follows the project's style guidelines.
  • I have updated the documentation accordingly.
  • I have reviewed the contribution guidelines for this project.
  • Test coverage for new or modified code paths
  • Changelog is updated
  • Required documentation changes (e.g., docs/rpc/openapi.yaml and rpc-endpoints.md for v2 endpoints, event-dispatcher.md for new events)
  • New clarity functions have corresponding PR in clarity-benchmarking repo
  • New integration test(s) added to bitcoin-tests.yml

@Pearltechie Pearltechie requested a review from a team as a code owner November 19, 2024 12:50
@CLAassistant
Copy link

CLAassistant commented Nov 19, 2024

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@Pearltechie Pearltechie changed the title *''Update docs to reflect segwit support in Stacks 2.1. ''* Update docs to reflect segwit support in Stacks 2.1 Nov 19, 2024
Copy link
Author

Choose a reason for hiding this comment

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

I have fix it, now the sentence syntax is correct in English. Thanks

@Pearltechie
Copy link
Author

Pearltechie commented Nov 19, 2024 via email

@Pearltechie
Copy link
Author

Pearltechie commented Nov 27, 2024

@jcnelson I hope you're doing well. I wanted to provide some context regarding my pull request (#5480) and seek your guidance on resolving the mutation testing issue.

In my contribution, I only made a small change to update the message that previously stated "Not a native segwit address" to reflect that "Native segwit address is now supported as of Stacks 2.1." I didn't touch any other part of the codebase.

However, I received a failure notification regarding mutation testing, and my status now shows "Action Required." Since I don't have knowledge of how to address this issue, I would greatly appreciate your help in identifying what went wrong and what steps I can take to fix it.

Thank you for your time and support! Please let me know if you need any further details about my changes.

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.

4 participants