Skip to content

PHPORM-77 Rename project #2576

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

Merged
merged 3 commits into from
Aug 30, 2023
Merged

PHPORM-77 Rename project #2576

merged 3 commits into from
Aug 30, 2023

Conversation

GromNaN
Copy link
Member

@GromNaN GromNaN commented Aug 22, 2023

Fix PHPORM-77

  • Change namespace MongoDB\Laravel
  • Rename package mongodb/laravel-mongodb
  • Remove founding
  • Update code of conduct according to MongoDB code of conduct.
  • Change code ownership in License file and composer.json
  • Update README
  • Move repository to https://github.com/mongodb/laravel-mongodb
  • Setup codecov webhook

@GromNaN GromNaN force-pushed the rename branch 2 times, most recently from dfc7436 to 0e9fc93 Compare August 22, 2023 21:12
@GromNaN GromNaN changed the title Rename project PHPORM-77 Rename project Aug 22, 2023
CHANGELOG.md Outdated

- Rename package to `mongodb/laravel-eloquent`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Rename package to `mongodb/laravel-eloquent`
- Rename package to `mongodb/laravel`

Hello,

Sorry to ask but wouldn't it be better to rename the package to mongodb/laravel as it's easy to remember and to type as well...

Thanks!

Copy link
Member Author

Choose a reason for hiding this comment

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

Indeed that's a good question that we are discussing with @alcaeus.

Copy link
Member Author

Choose a reason for hiding this comment

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

We will follow @chalasr recommendation and name the composer package like the GitHub project: mongodb/laravel-mongodb to eliminate any ambiguity.

Copy link
Contributor

@divine divine Aug 29, 2023

Choose a reason for hiding this comment

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

Hello,

This doesn’t make sense. If you use namespace MongoDB/Laravel then the package name should follow it?

Maybe change the namespace as well or should each and every package named twice? Like mysql/laravel-mysql it’s already under MySQL organization and you can understand that it’s especially for Laravel. I’m sure you’ll ask what was the reason behind it, well, there is no logical reason behind it.

Anyway, looks like I’m not a collaborator anymore and my suggestion doesn’t have any power. No problem.

Looking at all libraries under MongoDB organizations there are a lot of repositories that start with mongo-

If I'm going to install a PHP library like:
composer require mongodb/mongodb

Which of the following would make sense to install the Laravel version?

composer require mongodb/laravel-mongodb
composer require mongodb/mongodb-laravel
composer require mongodb/mongo-laravel
composer require mongodb/laravel

This is a very important question that needs a quite good decision because later you won't be able to change the package name...

Thanks!

Copy link
Member Author

@GromNaN GromNaN Aug 30, 2023

Choose a reason for hiding this comment

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

Hello @divine.

At first sight I wasn't convinced by this duplication either, but that's the best name we can find.

In mongodb/laravel-mongodb, the 1st mongodb it the vendor: the MongoDB company taking over the maintenance. The 2nd laravel-mongodb is the package name that indicate this is a package for both Laravel (the framework) and MongoDB (the database).
In the same way, the project needs to be in MongoDB's GitHub organisation. We keep the project name laravel-mongodb that is commonly used to refer to this project in issues and docs. When forking the project for contribution, the fork name stay descriptive even if it loose it's org part.
If we called it mongodb/laravel, this could be interpreted as a fork of laravel/laravel.
Having a match between the project name on GitHub and the package name in Composer make things easier for developers to locate the source code of the package from its name.

Copy link
Member Author

Choose a reason for hiding this comment

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

Anyway, looks like I’m not a collaborator anymore and my suggestion doesn’t have any power. No problem.

Your work on this project is remarkable. I want you to be able to continue to contribute as you are doing.

Permissions management has changed with the move to MongoDB's GitHub organization.

@GromNaN GromNaN marked this pull request as ready for review August 29, 2023 10:31
@GromNaN GromNaN requested a review from alcaeus August 29, 2023 10:32
Copy link
Member

@alcaeus alcaeus left a comment

Choose a reason for hiding this comment

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

LGTM. Merging now makes some links invalid until we move the repo to the mongodb org, but that's a risk I'm willing to take.

Co-authored-by: Andreas Braun <[email protected]>
@GromNaN
Copy link
Member Author

GromNaN commented Aug 29, 2023

I'll merge it tomorrow morning.

@GromNaN GromNaN merged commit 25c73e2 into mongodb:master Aug 30, 2023
@GromNaN GromNaN deleted the rename branch August 30, 2023 10:16
@GromNaN GromNaN added this to the 4.0.0 milestone Aug 30, 2023
@divine
Copy link
Contributor

divine commented Sep 7, 2023

Hello,

Probably this deserves a new issue but sorry for writing it here.

The only thing that catched my eyes is https://www.mongodb.com/compatibility/mongodb-laravel-intergration link which still refers old library name a lot.

Those names at that link should be probably updated so it will consistent with the documentation on Github to make it clear that MongoDB Inc. is the developer for this library and it works very well.

Thanks!

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.

3 participants