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

Clean up README.md #2129

Closed
5 tasks done
compulim opened this issue Jun 27, 2019 · 2 comments · Fixed by #2159
Closed
5 tasks done

Clean up README.md #2129

compulim opened this issue Jun 27, 2019 · 2 comments · Fixed by #2159
Assignees
Labels
bug Indicates an unexpected problem or an unintended behavior. front-burner

Comments

@compulim
Copy link
Contributor

compulim commented Jun 27, 2019

Describe the bug

Things to clean up in README.md and CHANGELOG.md before release. Please add to this list if something come up in your mind.

Since the clean up could be big and potentially conflicting with all incoming PRs, so make it just before release will ease our burden on merging PRs.

  • *: Microsoft organization name change
    • https://github.com/Microsoft/BotFramework-WebChat should become https://github.com/microsoft/BotFramework-WebChat
    • Our organization name changed to lowercase
  • CHANGELOG.md: "Update Japanese locale to" or "Update Japanese to"
    • We have mixed use of "Update XXX locale to", and "Update XXX to"
  • Typo for CHANGELOG.md
    • sip to SIP or sip:
    • "AdaptiveCards" to "Adaptive Cards"
  • Typo for 19.a/README.md line 138
    • Add a note for PROXY_BOT_URL
      • "To enable this feature, add PROXY_BOT_URL=http://localhost:3978 to /web/.env"
      • This note can be found in other samples (19.b and 20.a)

Addendum for typos for CHANGELOG.md

  • Fix #1980. Changed sendBoxTextArea styles to break words longer than the <textarea>, by @tdurnford in PR #1986
  • Fix #1429. Changed Markdown-It options to render newline characters correctly, by @tdurnford in PR #1988

[Bug]

@compulim compulim added bug Indicates an unexpected problem or an unintended behavior. Pending labels Jun 27, 2019
@corinagum corinagum self-assigned this Jun 27, 2019
@corinagum
Copy link
Contributor

corinagum commented Jul 8, 2019

Almost ready to start work on this one - just waiting for 2 more PR's to be merged in.

@corinagum
Copy link
Contributor

Not sure what your fix is for #1429 (last item)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Indicates an unexpected problem or an unintended behavior. front-burner
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants