Skip to content

Update README's and CONTRIBUTING guides #969

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Feb 6, 2023
Merged

Update README's and CONTRIBUTING guides #969

merged 2 commits into from
Feb 6, 2023

Conversation

@bidoubiwa
Copy link
Contributor

@bidoubiwa bidoubiwa commented Feb 1, 2023 •
edited
Loading

As the repository is now a mono-repo, the contributing guide had to be updated accordingly

@changeset-bot
Copy link

changeset-bot bot commented Feb 1, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: fe00d0d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@bidoubiwa bidoubiwa force-pushed the create_root_readme branch 3 times, most recently from c2f5dce to ed8d300 Compare February 1, 2023 15:10
@bidoubiwa bidoubiwa force-pushed the create_root_readme branch 2 times, most recently from c54938c to aa5ea9f Compare February 1, 2023 16:12
@bidoubiwa bidoubiwa marked this pull request as ready for review February 1, 2023 16:15
@bidoubiwa bidoubiwa added the skip-changelog The PR will not appear in the release changelogs label Feb 1, 2023
@bidoubiwa bidoubiwa changed the title Update README's Update README's and CONTRIBUTING guides Feb 1, 2023
@bidoubiwa bidoubiwa force-pushed the create_root_readme branch 4 times, most recently from d995ab9 to 90a4dd9 Compare February 1, 2023 17:47
brunoocasali
brunoocasali approved these changes Feb 2, 2023
View reviewed changes
README.md
@@ -0,0 +1,56 @@
<p align="center">
Copy link
Member

@brunoocasali brunoocasali Feb 2, 2023

Choose a reason for hiding this comment

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

Loved the explanation, I just don't feel the "Meilisearch Javascript plugins" is the right choice, but I don't have any other suggestion, so I'm just thinking out loud!

Maybe @alallema has one?

Copy link
Contributor Author

@bidoubiwa bidoubiwa Feb 6, 2023

Choose a reason for hiding this comment

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

After internal discussion, the repo will be named meilisearch-js-plugins. Thus the title may be kept as javascript inside the readme

CONTRIBUTING.md

If you want to test a specific package, provide it using the `filter` flag. For example:
```
turbo run test --filter=@meilisearch/instant-meilisearch
Copy link
Member

@brunoocasali brunoocasali Feb 2, 2023

Choose a reason for hiding this comment

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

You still have to be in the root dir, right?

Copy link
Contributor Author

@bidoubiwa bidoubiwa Feb 2, 2023

Choose a reason for hiding this comment

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

I improved the explaination:

If you want to test a specific package, from the root directory run any of the above command with the filter flag.

Example:

turbo run test --filter=@meilisearch/instant-meilisearch

Copy link
Member

@brunoocasali brunoocasali Feb 2, 2023

Choose a reason for hiding this comment

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

perfect! 👯

@bidoubiwa bidoubiwa requested review from alallema and mdubus February 2, 2023 10:27
mdubus
mdubus reviewed Feb 2, 2023
View reviewed changes
@mdubus mdubus self-requested a review February 6, 2023 16:29
mdubus
mdubus approved these changes Feb 6, 2023
View reviewed changes
Copy link
Member

@mdubus mdubus left a comment

Choose a reason for hiding this comment

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

LGTM ✨🦕

@bidoubiwa bidoubiwa merged commit e76792e into beta/lerna-migration Feb 6, 2023
@bidoubiwa bidoubiwa deleted the create_root_readme branch February 6, 2023 16:39
bidoubiwa added a commit that referenced this pull request Feb 7, 2023
@bidoubiwa
Update README's and CONTRIBUTING guides (#969)
693ffc1 
* Update README's

* Update README's
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@brunoocasali brunoocasali brunoocasali approved these changes

@mdubus mdubus mdubus approved these changes

@alallema alallema Awaiting requested review from alallema

Assignees

No one assigned

Labels

skip-changelog The PR will not appear in the release changelogs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@bidoubiwa @brunoocasali @mdubus