Add missing READMEs & Update package.json in all RN packages#37090
Add missing READMEs & Update package.json in all RN packages#37090Pranav-yadav wants to merge 1 commit into
Conversation
Base commit: b0cf746 |
|
This PR is stacked on "Update Node.js to v16".
Note: I'll be unavailable due to uni. exams, if everything is okay, then please rebase (try |
4050d28 to
85d3519
Compare
There was a problem hiding this comment.
Using symbols like ⚛️ in description is just extra noise for npm and other registries, that too at the start of the descriptions string.
Removing such symbols should make the search easier and should make the packages more accessible.
Same applies for all package.json files.
There was a problem hiding this comment.
git@ (old) & git:// (new) are more prone to attacks than https://.
Due to the lack of TLS or other cryptography, cloning over
git://might lead to an arbitrary code execution vulnerability, and should therefore be avoided unless you know what you are doing.
If you run
git clone git://example.com/project.git, an attacker who controls e.g your router can modify the repo you just cloned, inserting malicious code into it. If you then compile/run the code you just cloned, you will execute the malicious code. Runninggit clone http://example.com/project.gitshould be avoided for the same reason.
Running
git clone https://example.com/project.gitdoes not suffer from the same problem (unless the attacker can provide a TLS certificate for example.com). Runninggit clone [git@example.com]:project.gitonly suffers from this problem if you accept a wrong ssh key fingerprint.
Reference: https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols
It is very informative read 😃
|
Update: Had some free time, so rebased & resolved the conflicts 😅. @hoxyq I've left self review above explaining why particular changes are done. cc: @cortinico |
There was a problem hiding this comment.
Are we okay with these keywords?
There was a problem hiding this comment.
PS. I took them from keyword on RN gh repo page :)
There was a problem hiding this comment.
What is the purpose of #readme suffix in all these links? Do we want to navigate to README file?
There was a problem hiding this comment.
Yup, that's the purpose of "homepage" field in case of packages under monorepo, unless we've specific page for each package on RN/any other website.
PS. If you look closely exact similar links are already used in RN packages.
There was a problem hiding this comment.
Also, #... is just a "fragment" and won't break urls in any case.
85d3519 to
03c1116
Compare
|
Rebased & addressed suggestions re: jest testing syntax 👍 |
For all public RN packages: - Add missing READMEs - Add issues, bugs urls - Add keywords and homepage urls to respective pkgs
03c1116 to
88ab7a1
Compare
|
@hoxyq has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
Summary:
This diff adds missing README files for all public RN packages.
Changes:
For all public RN packages:
Update package.json in all RN packages to add:
Changelog:
[GENERAL][ADDED] - Add missing README files for all public RN packages.
[GENERAL][CHANGED] - Update package.json in all RN packages to add required fields.
Test Plan:
yarn lint && yarn flow && yarn test-ci--> should be green