tec3/five-for-the-future
tec3/five-for-the-future
1
0
Fork 0
mirror of https://github.com/WordPress/five-for-the-future.git synced 2025-04-20 10:03:43 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Readme updates

Browse source
This commit is contained in:
Caleb Burks 2019-11-06 19:43:22 -06:00
parent 10a4f3a674
commit ab233aa936
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
readme.md
View file

@ -11,15 +11,14 @@ In order to contribute with code changes, you'll want to set up a local environm
1) Use whichever local WordPress development setup you prefer and create a new local WP site.
2) Find the `wp-content` folder and delete it (make a backup if you have data you don't want to lose data you already have there).
3) Fork the [five-for-the-future](https://github.com/WordPress/five-for-the-future) repository under your own Github account.
4) Run `git clone git@github.com:WordPress/five-for-the-future.git wp-content`. Replace `WordPress/` with your Github `USERNAME/` to clone your newly forked repo instead.
4) Run `git clone git@github.com:[your username]/five-for-the-future.git wp-content`, replacing `[your username]` with your github username to clone your forked repo.
5) Ensure this newly cloned `wp-content` folder is where it should be in the WP structure.
6) Copy over the base theme with: `svn export https://meta.svn.wordpress.org/sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg themes/pub/wporg` (this should be run from the `wp-content` folder).
### Configuring the site
1) Login to your site and activate the "Five for the Future" theme and plugin.
2) Navigate to `wp-content/themes/pub/wporg` from your CLI and run: `npm install && grunt default`
3) Navigate to `/wp-content/themes/wporg-5ftf` and run: `npm install && npm run build`
2) Navigate to `/wp-content/themes/wporg-5ftf` and run: `npm install && npm run build`
### Setting up default data
@ -43,12 +42,12 @@ And lastly, you can run PHPCS for both the theme and the plugin at the root `/wp
### Submitting Pull Requests
The first thing you'll want to do before changing any code is create a new branch based on the production/master branch. Then you can commit your code changes locally and push this new branch to your forked repository on Github. Then visit the [official repository](https://github.com/WordPress/five-for-the-future/) and you should see the option to open up a Pull Request based on the recently pushed branch on your fork.
The first thing you'll want to do before changing any code is create a new branch based on the `production` branch. Then you can commit your code changes locally and push this new branch to your forked repository on Github. Then visit the [official repository](https://github.com/WordPress/five-for-the-future/) and you should see the option to open up a Pull Request based on the recently pushed branch on your fork.
Overtime your fork will fall out of date with what is on the main repository. What you'll want to do is keep your fork's production/master branch synced with the upstream production branch. To do this:
Overtime your fork will fall out of date with what is on the main repository. What you'll want to do is keep your fork's `production` branch synced with the upstream `production` branch. To do this:
1) In the `/wp-content/` folder, run `git remote add upstream https://github.com/WordPress/five-for-the-future`
2) Then `git fetch upstream` to pull down the upstream changes.
3) Lastly, `git checkout production && git merge upstream/production` to sync up the your local branch with the upstream branch.
This is why it's important to always create a branch on your local fork before making code changes. You want to keep the production/master branch clean and in sync with the upstream repository.
This is why it's important to always create a branch on your local fork before making code changes. You want to keep the `production` branch clean and in sync with the upstream repository.