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: (README.md) Update readme to add bugs, fr #6669

Merged
merged 7 commits into from Oct 15, 2020
Merged

Conversation

sammartinez
Copy link
Contributor

@sammartinez sammartinez commented Aug 27, 2020

Issue #, if available:

Description of changes:
With the majority of our issues being related to feature requests, I wanted to provide a way to customers to see this on our README. This will show our feature requests currently present along with current bugs and closed issues

Screenshot:
feature_requests_showing

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@codecov
Copy link

codecov bot commented Aug 27, 2020

Codecov Report

Merging #6669 into main will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #6669   +/-   ##
=======================================
  Coverage   73.27%   73.27%           
=======================================
  Files         213      213           
  Lines       13195    13195           
  Branches     2584     2488   -96     
=======================================
  Hits         9669     9669           
- Misses       3332     3362   +30     
+ Partials      194      164   -30     
Impacted Files Coverage Δ
packages/auth/src/OAuth/OAuth.ts 56.11% <0.00%> (ø)
packages/core/src/Credentials.ts 31.51% <0.00%> (ø)
packages/analytics/src/Analytics.ts 63.58% <0.00%> (ø)
packages/datastore/src/sync/index.ts 15.41% <0.00%> (ø)
packages/datastore/src/sync/outbox.ts 24.00% <0.00%> (ø)
packages/datastore/src/storage/storage.ts 71.66% <0.00%> (ø)
packages/core/src/OAuthHelper/GoogleOAuth.ts 33.33% <0.00%> (ø)
packages/core/src/Util/Reachability.native.ts 37.50% <0.00%> (ø)
packages/xr/src/Providers/SumerianProvider.ts 47.55% <0.00%> (ø)
packages/core/src/OAuthHelper/FacebookOAuth.ts 34.69% <0.00%> (ø)
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2f74c6b...69ec052. Read the comment docs.

@sammartinez sammartinez self-assigned this Oct 12, 2020
@sammartinez sammartinez added the needs-review Used as a label in order to review open PRs label Oct 12, 2020
@sammartinez sammartinez marked this pull request as ready for review October 12, 2020 23:01
README.md Outdated
@@ -17,6 +17,11 @@
</a>
</p>

## Reporting Bugs/Feature Requests
Copy link
Contributor

Choose a reason for hiding this comment

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

I like these stats! They really help indicate the "health" better than the 658 at the top of the page.

Is this headline needed? It feels a bit out-of-place at the top of the README.

(CC @renebrandel)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is similar to what iOS is doing so Im curious what @renebrandel thinks as well. May not be needed but I can make the update as needed

Copy link
Contributor

@ashika01 ashika01 left a comment

Choose a reason for hiding this comment

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

I like this 👍 Maybe bring down the header size by 1?

@renebrandel
Copy link

Love it. We should also add this to the CLI repo.

@sammartinez
Copy link
Contributor Author

Love it. We should also add this to the CLI repo.

Sounds good! Ill look to cut a PR to CLI today then for it :)

Copy link
Contributor

@ericclemmons ericclemmons left a comment

Choose a reason for hiding this comment

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

Ready to approve, but I added @sammartinez 's change to an H#.

README.md Outdated Show resolved Hide resolved
Co-authored-by: Eric Clemmons <eric@smarterspam.com>
@sammartinez sammartinez merged commit 14478e0 into main Oct 15, 2020
@sammartinez sammartinez deleted the readme-adjustment branch December 2, 2020 23:48
@github-actions
Copy link

github-actions bot commented Dec 3, 2021

This pull request has been automatically locked since there hasn't been any recent activity after it was closed. Please open a new issue for related bugs.

Looking for a help forum? We recommend joining the Amplify Community Discord server *-help channels or Discussions for those types of questions.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 3, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
needs-review Used as a label in order to review open PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants