README project team/code owners #1973
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #1973 +/- ##
=======================================
Coverage 74.45% 74.45%
=======================================
Files 281 281
Lines 7817 7817
Branches 973 973
=======================================
Hits 5820 5820
Misses 1880 1880
Partials 117 117
Continue to review full report at Codecov.
|
Closed
|
I'm aware of the CODEOWNERS file now. But the file does not list all C Labs contributors? Maybe still a useful section? I'll leave the decision to you. |
|
I think github integrates CODEOWNERS quite nicely so I suggest we just leave it at that. In the future we could add a "Team" or "Contributors" section to the README when it would help contributors get recognized. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Part of a larger README update
Added a section which could be a start of the list of code owners for certain parts of the monorepo.
For an outsider its not really clear who is the core team and who works on celo cli, Android, smart contracts, etc
What do you think?
Rationale: For some users the celo monorepo could be the first impression they have of celo. A
A nice README is a good way to help people engage in the project as well. A project with nice README and screenshots will get the attention of users better since it’s a direct way to explain why this project matters, and why people should use and contribute to the project. Good README should also include enough details to help a new user get started, e.g. how to compile, how to install, and how to start integrating.
README educational content I used.
A beginners guide to writing kickass readmes
AWESOME READMEs