Skip to content

[3.4] Improve project description #9

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 1 commit into from
Jan 11, 2021
Merged

[3.4] Improve project description #9

merged 1 commit into from
Jan 11, 2021

Conversation

TavoNiievez
Copy link
Member

No description provided.

@Naktibalda
Copy link
Member

Why could anyone want to create a new project based on this repository?

@TavoNiievez
Copy link
Member Author

To reproduce a bug and share it for investigation.
To verify the operation of a method in a minimal installation of the framework.
To analyze configuration details that may be causing problems in the personal project.

composer create-project is just a shortcut for git clone and composer install. Besides that, it allows to include scripts and to be able to automate the steps that were previously manual, such as configuring the database.

The purpose of the project is not to serve as a template.

@Naktibalda
Copy link
Member

Is it possible to raise a pull request to this repository from project created using composer create-project?

@TavoNiievez
Copy link
Member Author

also not possible with git clone https://github.com/Codeception/symfony-module-tests.git

@TavoNiievez
Copy link
Member Author

If replacing the long way with the short one does not convince you (I repeat, the behavior is exactly the same), I can modify the PRs so that the long version remains as an option. I can also include a description of what is the expected use of the project.

I just need you to tell me what changes you would like.

@TavoNiievez
Copy link
Member Author

Including a link to the contribution guides could also be helpful.

@Naktibalda
Copy link
Member

Then these instructions aren't (and weren't) fit for purpose "to reproduce a bug and share it for investigation".

I think that it would be the best to delete installation instructions and replace them with link to your contribution guide https://github.com/Codeception/module-symfony/blob/master/CONTRIBUTING.md

@TavoNiievez
Copy link
Member Author

well, at some point you had to install the project 😆 .

OK, I'll make the changes at the end of the day.

Thanks for the feedback

@TavoNiievez
Copy link
Member Author

@Naktibalda I made the changes. Is it better this way?

@ThomasLandauer
Copy link
Member

I think you shouldn't remove the installation instructions, since they're referenced at https://github.com/Codeception/module-symfony/blob/master/CONTRIBUTING.md

Go to Codeception/symfony-module-tests and fork the project. Then follow the installation instructions.

@TavoNiievez
Copy link
Member Author

TavoNiievez commented Jan 7, 2021

What Naktibalda suggests is that they be added to the contribution guides.

Since the exact command you must run if you want to contribute involves cloning your fork, and not cloning the original repository.

@TavoNiievez
Copy link
Member Author

TavoNiievez commented Jan 7, 2021

@ThomasLandauer Can you please include the 3 commands that I remove here in the contribution guides?

1. Clone your fork locally
2. Install Composer dependencies
3. Update database schema and load Doctrine fixtures

It can be in the PR that you already have open.

ThomasLandauer added a commit to ThomasLandauer/module-symfony that referenced this pull request Jan 7, 2021
@TavoNiievez TavoNiievez changed the title [3.4] Use composer to create the project [3.4] Improve project description Jan 11, 2021
@TavoNiievez TavoNiievez merged commit 9eccd92 into Codeception:3.4 Jan 11, 2021
@TavoNiievez TavoNiievez deleted the 3.4 branch January 11, 2021 14:08
@TavoNiievez
Copy link
Member Author

Just for the record i proposed this because installing phalcon/demo with composer is already possible and even the test project readme explains both

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