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

chore: improve README.md standardization #324

Merged
merged 8 commits into from
Aug 22, 2023
Merged

chore: improve README.md standardization #324

merged 8 commits into from
Aug 22, 2023

Conversation

smcclellan
Copy link
Contributor

@smcclellan smcclellan commented Jul 13, 2023

This PR was published to npm with the alpha versions:

  • connect npm install @stacks/connect@7.3.2-alpha.961215c.0 --save-exact
  • connect-react npm install @stacks/connect-react@22.1.2-alpha.961215c.0 --save-exact
  • connect-ui npm install @stacks/connect-ui@6.1.2-alpha.961215c.0 --save-exact

Use the following template to create your pull request

Description

Describe the changes that where made in this pull request. When possible start with a user story - short, simple descriptions of a feature told from the perspective of the person who desires the new capability. Be sure to also include the following information:

  1. Motivation for change
  2. What was changed
  3. How does this impact application developers
  4. Link to relevant issues and documentation
  5. Provide examples of use cases with code samples and applicable acceptance criteria

Example:
As a Blockstack developer, I would like to encrypt files using the app private key. This is needed because storing unencrypted files is unacceptable. This pull request adds the encryptContent function which will take a string and encrypt it using the app private key.

encryptContent('my data')

// Running the above should result in the following encrypted data object
{"iv":"c91...","ephemeralPK":"031...","cipherText":"d61...","mac":"e73..."}

For details refer to issue #123

Type of Change

  • New feature
  • Bug fix
  • API reference/documentation update
  • Other

Does this introduce a breaking change?

List the APIs or describe the functionality that this PR breaks.
Workarounds for or expected timeline for deprecation

Are documentation updates required?

  • Link to documentation updates:

Testing information

Provide context on how tests should be performed.

  1. Is testing required for this change?
  2. If it’s a bug fix, list steps to reproduce the bug
  3. Briefly mention affected code paths
  4. List other affected projects if possible
  5. Things to watch out for when testing

Checklist

  • Code is commented where needed
  • Unit test coverage for new or modified code paths
  • yarn lerna run test passes
  • Changelog is updated
  • Tag 1 of @hstove or @kyranjamie or @aulneau for review

@smcclellan smcclellan requested a review from janniks July 13, 2023 02:45
@changeset-bot
Copy link

changeset-bot bot commented Jul 13, 2023

⚠️ No Changeset found

Latest commit: 961215c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Jul 13, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
connect-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 22, 2023 2:05pm

.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@janniks janniks merged commit 936023a into main Aug 22, 2023
4 of 5 checks passed
@janniks janniks deleted the update-readme branch August 22, 2023 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants