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

Improve composer.json #57

Merged
merged 4 commits into from
Jun 7, 2019
Merged

Improve composer.json #57

merged 4 commits into from
Jun 7, 2019

Conversation

christianc1
Copy link
Member

Improve composer.json

This pull request makes two changes to the composer.json file.

The first adds the type attribute, which designates this as WordPress plugin to ease the process for adding this as a dependency to a WordPress installation as a composer package. More info here.

The second adds the license attribute to the composer.json file. Without this present, the composer.json file is not technically valid, as demonstrated by running composer validate. More info here.

Benefits

Valid composer.json that a WordPress site can add/manage via Composer.

Verification Process

composer validate

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.

Applicable Issues

#56

@christianc1 christianc1 self-assigned this Apr 18, 2019
@christianc1 christianc1 added the type:enhancement New feature or request. label Apr 18, 2019
@jeffpaul jeffpaul added this to the 1.3.0 milestone Apr 18, 2019
@jeffpaul jeffpaul requested a review from helen April 25, 2019 16:13
@helen
Copy link
Contributor

helen commented Apr 25, 2019

@christianc1 Does it work to include this via Composer when the built files are not included in the repo?

@christianc1
Copy link
Member Author

@helen I installed this on a site that's still on Classic Editor. Looks like the dist js is for Gutenberg, so I didn't even realize. We can probably hold while we figure out if we want to support Composer based installs. Thinking about how we distribute this, does it might make sense regardless to have build files in the repository?

@helen
Copy link
Contributor

helen commented May 22, 2019

Sorry, I completely lost track of this! So the production-ready version of this plugin, like Distributor, lives in the stable branch. If we keep the composer.json file in there, would that be good enough?

@christianc1
Copy link
Member Author

Works for me @helen

@helen helen merged commit 44fc227 into develop Jun 7, 2019
@helen helen mentioned this pull request Jun 7, 2019
@jeffpaul jeffpaul deleted the feature/composer-type branch March 5, 2020 01:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:enhancement New feature or request.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants