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

Add branch messaging across respective files #2248

Merged
merged 2 commits into from
Jul 1, 2021
Merged

Add branch messaging across respective files #2248

merged 2 commits into from
Jul 1, 2021

Conversation

jeffpaul
Copy link
Member

Description of the Change

This PR adds messaging to changelogs and readmes to alert folks to the pending change, currently listed as coming in the 3.7.0 release, of removing built assets from develop, building into a stable branch, and removing master in favor of trunk and removing built assets from trunk.

This PR only attempts to cover the first checkbox here: #2182 (comment). We'll want to mirror this messaging across future 3.6.* releases to continue communicating these pending changes. We'll also need to work through the additional checkboxes on #2181, happy to help with more there as desired.

Alternate Designs

Potentially adding messaging into other places across the codebase, or adjusting copy to be more precise.

Benefits

Ensures we attempt to alert as broad a base of users as possible ahead of making these changes.

Possible Drawbacks

None identified besides over communicating.

Verification Process

Verified via VS Code and GitHub Desktop UI.

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.

Applicable Issues

Relates to #2182.

Changelog Entry

### Added
- Documentation updates (props @jeffpaul).

@jeffpaul jeffpaul added this to the 3.6.0 milestone Jun 30, 2021
@jeffpaul jeffpaul self-assigned this Jun 30, 2021
@brandwaffle brandwaffle merged commit 970d6ff into develop Jul 1, 2021
@brandwaffle brandwaffle deleted the add/docs branch July 1, 2021 15:11
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