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

Dev Env setup Tutorial #137

Open
namithj opened this issue Nov 5, 2024 · 1 comment
Open

Dev Env setup Tutorial #137

namithj opened this issue Nov 5, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@namithj
Copy link
Contributor

namithj commented Nov 5, 2024

Tutorial for devs on how to setup the Dev environment like they are entirely new to the process.

All the pre requirements to running composer install should be covered.

This can help everyone get upto speed easily and reduce the entry bar.

@namithj namithj added the documentation Improvements or additions to documentation label Nov 5, 2024
@namithj
Copy link
Contributor Author

namithj commented Nov 6, 2024

Installation and usage

Installing composer

Linux & Mac:
`curl -sS [https://getcomposer.org/installer](https://getcomposer.org/installer) | php`
Windows installer:
Visit `https://getcomposer.org/download/` and download the `Composer-Setup.exe`

Using composer

`composer install` : Initially run to setup all dependencies.
`composer lint` : Checks the plugin files as per WPCS rules adopted by the plugin team
`composer format` : Format the plugin files as per WPCS rules adopted by the plugin team
`composer test` : Run Unit tests on the plugin code.

@namithj namithj assigned namithj and asirota and unassigned namithj Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants