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

DOCS README add repo structure section #1977

Closed
wants to merge 2 commits into from
Closed

DOCS README add repo structure section #1977

wants to merge 2 commits into from

Conversation

KoenBal
Copy link
Contributor

@KoenBal KoenBal commented Dec 2, 2019

Description

The repo structure section gives potential contributors an immediate idea of what parts they could contribute to without the need to having to dive into the folders.

Add a repo structure to the main README file.
See #1976 for some questions I have that could improve this section.

part of a larger README update

@timmoreton timmoreton self-assigned this Dec 4, 2019
@timmoreton
Copy link
Contributor

Thanks for the contributions! I’ll get chance to take a look later this week

@KoenBal
Copy link
Contributor Author

KoenBal commented Dec 4, 2019

Thanks for the contributions! I’ll get chance to take a look later this week

No worries. I already assumed there is more pressing work to do now with the upcoming launch. A great engineer strives to focus ;).

Copy link
Contributor

@timmoreton timmoreton left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution! Should have had this a long time ago. PTAL at the comments and see what else you can fill in.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@timmoreton timmoreton assigned KoenBal and unassigned timmoreton Dec 5, 2019
@codecov
Copy link

codecov bot commented Dec 6, 2019

Codecov Report

Merging #1977 into master will decrease coverage by 0.42%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1977      +/-   ##
==========================================
- Coverage   74.87%   74.45%   -0.43%     
==========================================
  Files         281      281              
  Lines        7805     7817      +12     
  Branches      972      685     -287     
==========================================
- Hits         5844     5820      -24     
- Misses       1845     1880      +35     
- Partials      116      117       +1
Flag Coverage Δ
#mobile 74.45% <ø> (-0.43%) ⬇️
Impacted Files Coverage Δ
packages/mobile/src/identity/verification.ts 64.97% <0%> (-15.71%) ⬇️
packages/mobile/src/identity/smsRetrieval.ts 44.44% <0%> (-11.12%) ⬇️
packages/mobile/src/identity/reducer.ts 48.14% <0%> (-1.86%) ⬇️
packages/mobile/src/networkInfo/saga.ts 32.25% <0%> (-1.08%) ⬇️
packages/mobile/src/import/ImportWalletEmpty.tsx 78.78% <0%> (-0.63%) ⬇️
packages/mobile/src/geth/networkConfig.ts 100% <0%> (ø) ⬆️
packages/mobile/src/identity/contactMapping.ts 88.59% <0%> (+0.1%) ⬆️
packages/mobile/src/localCurrency/saga.ts 69.23% <0%> (+1.37%) ⬆️
packages/mobile/src/identity/commentKey.ts 42.85% <0%> (+4.39%) ⬆️
packages/mobile/src/import/ImportWallet.tsx 95.83% <0%> (+5.44%) ⬆️

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 f2db852...3c4af50. Read the comment docs.

@KoenBal KoenBal removed their assignment Dec 6, 2019
@KoenBal
Copy link
Contributor Author

KoenBal commented Dec 6, 2019

Thx for the feedback.
Pushed adjustments.
@timmoreton could un-assign me but not assing it back to you.
#2111 Should solve all these assigning problems.

@timmoreton
Copy link
Contributor

Wrapped these up in #2201 - PTAL!

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.

2 participants