Skip to content

Commit bc5c097

Browse files
authored
Merge pull request #19 from JackieBinya/update-contribute
Updates contributing information
2 parents a994868 + c669795 commit bc5c097

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

CONTRIBUTE.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,17 @@ guidelines on the Creative Common Open Source website.
2424

2525
[contributing]:https://creativecommons.github.io/contributing-code/
2626

27+
### Prerequisites
28+
29+
The technologies below must be installed locally in your computer:
30+
* Web Server: Apache or Nginx
31+
* Database: [MySQL][mysql] version 5.0.15 or greater or any version of MariaDB.
32+
* [PHP][php]: Version 7.3 or greater.
33+
* [WordPress][wordpress]: Version 5.2 or greater
34+
35+
[php]: https://www.php.net/manual/en/install.php
36+
[mysql]: https://dev.mysql.com/doc/mysql-installation-excerpt/5.7/en/
37+
[wordpress]: https://wordpress.org/support/article/how-to-install-wordpress/
2738

2839
### Development
2940

@@ -73,6 +84,11 @@ If you are not setup to detect WPCS errors, consider the following steps.
7384
export PATH="$HOME/.composer/vendor/bin:$PATH"
7485
```
7586

87+
If you are using a Linux distro e.g. Ubuntu add the path below to your `.bashrc ` file:
88+
```shell
89+
export PATH="$HOME/.config/composer/vendor/bin:$PATH"
90+
```
91+
7692
4. **Setup WPCS**
7793

7894
Clone the official [WordPress Coding Standards repository][wpcs-repo] in
@@ -127,7 +143,28 @@ If you are not setup to detect WPCS errors, consider the following steps.
127143
fix, you are good to go.
128144

129145
[wpcs-repo]: https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards
130-
[phpcs]: https://marketplace.visualstudio.com/items?itemName=ikappas.phpcs
146+
[phpcs]: https://marketplace.visualstudio.com/items?itemName=ikappas.phpcs
147+
148+
**Running the ``wp-theme-base`` locally**
149+
150+
* Fork [this][wp-theme-base] repository on GitHub.
151+
* Locally in your computer, open the `wordpress` directory in your text editor.
152+
* Then navigate to the themes directory by running the command below on your terminal:
153+
```shell
154+
cd wp-content/themes/wp-theme-base
155+
```
156+
* Then clone your fork of [this][wp-theme-base] repository in the current directory.
157+
* After successfully cloning the project, navigate to the `wp-theme-base` directory and run the command below on the terminal, to install all the necessary package dependencies:
158+
```shell
159+
composer install
160+
```
161+
One of the installed dependencies is `Queulat`,in-order to initialize Queulat in the project follow the instruction provided in this [link][quelat].
162+
* Then you can proceed to run your server and activate the `wp-theme-base` in your local WordPress environment.
163+
Happy Coding!
164+
165+
[quelat]: https://github.com/felipelavinz/queulat#loading-queulat-as-mu-plugin
166+
[wp-theme-base]: https://github.com/creativecommons/wp-theme-base
167+
131168

132169
## Questions or Thoughts?
133170

0 commit comments

Comments
 (0)