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

New README.md strategy #6176

Merged
merged 2 commits into from
Oct 5, 2023
Merged

New README.md strategy #6176

merged 2 commits into from
Oct 5, 2023

Conversation

takameyer
Copy link
Contributor

  • Move README.md into packages/realm and replace with a symbolic link.
  • Update all relative paths in README.md to be absolute.
  • Replace realm.io links

☑️ ToDos

  • 📝 Changelog entry
  • 📝 Compatibility label is updated or copied from previous entry
  • 📝 Update COMPATIBILITY.md
  • 🚦 Tests
  • 📦 Updated internal package version in consuming package.jsons (if updating internal packages)
  • 📱 Check the React Native/other sample apps work if necessary
  • 💥 Breaking label has been applied or is not necessary

* Move README.md into `packages/realm` and replace with a symbolic link.
* Update all relative paths in README.md to be absolute.
* Replace realm.io links
@takameyer takameyer force-pushed the andrew/fix-readme-2nd-attempt branch from d6f23df to b312932 Compare October 5, 2023 10:24
@coveralls-official
Copy link

Coverage Status

coverage: 85.397%. remained the same when pulling b312932 on andrew/fix-readme-2nd-attempt into ab2ee63 on main.

@@ -96,9 +96,9 @@
"hooks"
],
"author": {
"name": "Realm",
"name": "MongoDB",
Copy link
Member

Choose a reason for hiding this comment

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

P.S. Some of the other package.jsons still have "name": "Realm".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, I wasn't sure if I was sold on that yet, but I guess MongoDB is the official author, so I can update that as well

@takameyer takameyer merged commit 06e073c into main Oct 5, 2023
11 of 18 checks passed
@takameyer takameyer deleted the andrew/fix-readme-2nd-attempt branch October 5, 2023 11:14
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants