Readme: Add detailed setup instructions to help contributors.

Fixes #86
This commit is contained in:
Caleb Burks 2022-03-30 16:37:15 -07:00 committed by Ian Dunn
parent d86c93c67e
commit f269c2a1ab
No known key found for this signature in database
GPG key ID: 99B971B50343CBCB
2 changed files with 619 additions and 0 deletions

563
.env/import.wxr Normal file
View file

@ -0,0 +1,563 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!-- This is a WordPress eXtended RSS file generated by WordPress as an export of your site. -->
<!-- It contains information about your site's posts, pages, comments, categories, and other content. -->
<!-- You may use this file to transfer that content from one site to another. -->
<!-- This file is not intended to serve as a complete backup of your site. -->
<!-- To import this information into a WordPress site follow these steps: -->
<!-- 1. Log in to that site as an administrator. -->
<!-- 2. Go to Tools: Import in the WordPress admin panel. -->
<!-- 3. Install the "WordPress" importer from the list. -->
<!-- 4. Activate & Run Importer. -->
<!-- 5. Upload this file using the form provided on that page. -->
<!-- 6. You will first be asked to map the authors in this export file to users -->
<!-- on the site. For each author, you may choose to map to an -->
<!-- existing user on the site or to create a new user. -->
<!-- 7. WordPress will then import each of the posts, pages, comments, categories, etc. -->
<!-- contained in this file into your site. -->
<!-- generator="WordPress/5.2.4" created="2019-11-06 05:06" -->
<rss version="2.0"
xmlns:excerpt="http://wordpress.org/export/1.2/excerpt/"
xmlns:content="http://purl.org/rss/1.0/modules/content/"
xmlns:wfw="http://wellformedweb.org/CommentAPI/"
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:wp="http://wordpress.org/export/1.2/"
>
<channel>
<title>five-for-the-future</title>
<link>http://five-for-the-future.test</link>
<description>Just another WordPress site</description>
<pubDate>Wed, 06 Nov 2019 05:06:32 +0000</pubDate>
<language>en-US</language>
<wp:wxr_version>1.2</wp:wxr_version>
<wp:base_site_url>http://five-for-the-future.test</wp:base_site_url>
<wp:base_blog_url>http://five-for-the-future.test</wp:base_blog_url>
<wp:author><wp:author_id>1</wp:author_id><wp:author_login><![CDATA[a]]></wp:author_login><wp:author_email><![CDATA[local@localhost.local]]></wp:author_email><wp:author_display_name><![CDATA[a]]></wp:author_display_name><wp:author_first_name><![CDATA[]]></wp:author_first_name><wp:author_last_name><![CDATA[]]></wp:author_last_name></wp:author>
<wp:category>
<wp:term_id>1</wp:term_id>
<wp:category_nicename><![CDATA[uncategorized]]></wp:category_nicename>
<wp:category_parent><![CDATA[]]></wp:category_parent>
<wp:cat_name><![CDATA[Uncategorized]]></wp:cat_name>
</wp:category>
<wp:term>
<wp:term_id><![CDATA[2]]></wp:term_id>
<wp:term_taxonomy><![CDATA[nav_menu]]></wp:term_taxonomy>
<wp:term_slug><![CDATA[primary]]></wp:term_slug>
<wp:term_parent><![CDATA[]]></wp:term_parent>
<wp:term_name><![CDATA[Primary]]></wp:term_name>
</wp:term>
<wp:term>
<wp:term_id><![CDATA[1]]></wp:term_id>
<wp:term_taxonomy><![CDATA[category]]></wp:term_taxonomy>
<wp:term_slug><![CDATA[uncategorized]]></wp:term_slug>
<wp:term_parent><![CDATA[]]></wp:term_parent>
<wp:term_name><![CDATA[Uncategorized]]></wp:term_name>
</wp:term>
<wp:term><wp:term_id>2</wp:term_id><wp:term_taxonomy>nav_menu</wp:term_taxonomy><wp:term_slug><![CDATA[primary]]></wp:term_slug><wp:term_name><![CDATA[Primary]]></wp:term_name>
</wp:term>
<generator>https://wordpress.org/?v=5.2.4</generator>
<item>
<title>About</title>
<link>http://five-for-the-future.test/</link>
<pubDate>Wed, 06 Nov 2019 04:48:09 +0000</pubDate>
<dc:creator><![CDATA[a]]></dc:creator>
<guid isPermaLink="false">http://five-for-the-future.test/?page_id=7</guid>
<description></description>
<content:encoded><![CDATA[<!-- wp:paragraph {"className":"is-style-wporg-tldr"} -->
<p class="is-style-wporg-tldr"><em>Ready to get started? Contribute as an <a href="/add-new-pledge">organization</a>.</em></p>
<!-- /wp:paragraph -->
<!-- wp:image {"id":24,"className":"size-large"} -->
<figure class="wp-block-image size-large"><img src="https://wordpress.org/five-for-the-future/files/2019/09/community-summit-paris.jpg" alt="Attendees of the 2017 WordPress Community Summit" class="wp-image-24"/></figure>
<!-- /wp:image -->
<!-- wp:pullquote {"className":"is-style-solid-color"} -->
<figure class="wp-block-pullquote is-style-solid-color"><blockquote><p>How five percent is powering the next generation of the web</p></blockquote></figure>
<!-- /wp:pullquote -->
<!-- wp:paragraph {"textColor":"wporg-white","backgroundColor":"wporg-blue"} -->
<p class="has-text-color has-background has-wporg-white-color has-wporg-blue-background-color">WordPress needs YOU!</p>
<!-- /wp:paragraph -->
<!-- wp:paragraph {"textColor":"wporg-white","backgroundColor":"wporg-blue"} -->
<p class="has-text-color has-background has-wporg-white-color has-wporg-blue-background-color">Five for the Future is an initiative promoting the WordPress communitys contribution to the platforms growth. As an open source project, WordPress is created by a diverse collection of people from around the world.</p>
<!-- /wp:paragraph -->
<!-- wp:heading -->
<h2>What is Five for the Future?</h2>
<!-- /wp:heading -->
<!-- wp:paragraph -->
<p>Launched in 2014, Five for the Future encourages organizations to contribute five percent of their resources to WordPress development. WordPress co-founder Matt Mullenweg set this benchmark to maintain a “golden ratio” of contributors to users.</p>
<!-- /wp:paragraph -->
<!-- wp:paragraph -->
<p>The community has risen to the challenge, with participation more than quadrupling since launch.</p>
<!-- /wp:paragraph -->
<!-- wp:heading -->
<h2>Who should participate</h2>
<!-- /wp:heading -->
<!-- wp:paragraph -->
<p>Anyone can contribute to Five for the Future. Many contributors focus on the technical side of WordPress, such as core development, but there are also teams working in other areas like marketing, translation, training, and community. There is always a way to get involved, whatever your skillset.</p>
<!-- /wp:paragraph -->
<!-- wp:heading -->
<h2>Why you should participate</h2>
<!-- /wp:heading -->
<!-- wp:paragraph -->
<p>Contributors have the opportunity to learn alongside passionate innovators who are more than happy to share their skills.</p>
<!-- /wp:paragraph -->
<!-- wp:paragraph -->
<p>For organizations, it is a more cost-effective training initiative than most traditional programs.</p>
<!-- /wp:paragraph -->
<!-- wp:paragraph -->
<p>Participants see a number of benefits:</p>
<!-- /wp:paragraph -->
<!-- wp:paragraph -->
<p>• Identifying and recruiting talent.<br>• Finding end-user customers or new clients.<br>• Influencing the direction of the WordPress platform.<br>• Contributing to the future of the operating system of the web.</p>
<!-- /wp:paragraph -->
<!-- wp:button -->
<div class="wp-block-button"><a class="wp-block-button__link" href="/pledges/">See all Pledged Contributors</a></div>
<!-- /wp:button -->]]></content:encoded>
<excerpt:encoded><![CDATA[]]></excerpt:encoded>
<wp:post_id>7</wp:post_id>
<wp:post_date><![CDATA[2019-11-06 04:48:09]]></wp:post_date>
<wp:post_date_gmt><![CDATA[2019-11-06 04:48:09]]></wp:post_date_gmt>
<wp:comment_status><![CDATA[closed]]></wp:comment_status>
<wp:ping_status><![CDATA[closed]]></wp:ping_status>
<wp:post_name><![CDATA[about]]></wp:post_name>
<wp:status><![CDATA[publish]]></wp:status>
<wp:post_parent>0</wp:post_parent>
<wp:menu_order>0</wp:menu_order>
<wp:post_type><![CDATA[page]]></wp:post_type>
<wp:post_password><![CDATA[]]></wp:post_password>
<wp:is_sticky>0</wp:is_sticky>
</item>
<item>
<title>Add New Pledge</title>
<link>http://five-for-the-future.test/add-new-pledge/</link>
<pubDate>Wed, 06 Nov 2019 04:51:02 +0000</pubDate>
<dc:creator><![CDATA[a]]></dc:creator>
<guid isPermaLink="false">http://five-for-the-future.test/?page_id=9</guid>
<description></description>
<content:encoded><![CDATA[<!-- wp:shortcode -->
[5ftf_pledge_form_new]
<!-- /wp:shortcode -->
<!-- wp:paragraph -->
<p></p>
<!-- /wp:paragraph -->]]></content:encoded>
<excerpt:encoded><![CDATA[]]></excerpt:encoded>
<wp:post_id>9</wp:post_id>
<wp:post_date><![CDATA[2019-11-06 04:51:02]]></wp:post_date>
<wp:post_date_gmt><![CDATA[2019-11-06 04:51:02]]></wp:post_date_gmt>
<wp:comment_status><![CDATA[closed]]></wp:comment_status>
<wp:ping_status><![CDATA[closed]]></wp:ping_status>
<wp:post_name><![CDATA[add-new-pledge]]></wp:post_name>
<wp:status><![CDATA[publish]]></wp:status>
<wp:post_parent>0</wp:post_parent>
<wp:menu_order>0</wp:menu_order>
<wp:post_type><![CDATA[page]]></wp:post_type>
<wp:post_password><![CDATA[]]></wp:post_password>
<wp:is_sticky>0</wp:is_sticky>
</item>
<item>
<title>My Pledges</title>
<link>http://five-for-the-future.test/my-pledges/</link>
<pubDate>Wed, 06 Nov 2019 04:53:26 +0000</pubDate>
<dc:creator><![CDATA[a]]></dc:creator>
<guid isPermaLink="false">http://five-for-the-future.test/?page_id=11</guid>
<description></description>
<content:encoded><![CDATA[<!-- wp:shortcode -->
[5ftf_my_pledges]
<!-- /wp:shortcode -->]]></content:encoded>
<excerpt:encoded><![CDATA[]]></excerpt:encoded>
<wp:post_id>11</wp:post_id>
<wp:post_date><![CDATA[2019-11-06 04:53:26]]></wp:post_date>
<wp:post_date_gmt><![CDATA[2019-11-06 04:53:26]]></wp:post_date_gmt>
<wp:comment_status><![CDATA[closed]]></wp:comment_status>
<wp:ping_status><![CDATA[closed]]></wp:ping_status>
<wp:post_name><![CDATA[my-pledges]]></wp:post_name>
<wp:status><![CDATA[publish]]></wp:status>
<wp:post_parent>0</wp:post_parent>
<wp:menu_order>0</wp:menu_order>
<wp:post_type><![CDATA[page]]></wp:post_type>
<wp:post_password><![CDATA[]]></wp:post_password>
<wp:is_sticky>0</wp:is_sticky>
</item>
<item>
<title>Manage Pledge</title>
<link>http://five-for-the-future.test/manage-pledge/</link>
<pubDate>Wed, 06 Nov 2019 04:56:04 +0000</pubDate>
<dc:creator><![CDATA[a]]></dc:creator>
<guid isPermaLink="false">http://five-for-the-future.test/?page_id=13</guid>
<description></description>
<content:encoded><![CDATA[<!-- wp:shortcode -->
[5ftf_pledge_form_manage]
<!-- /wp:shortcode -->
<!-- wp:paragraph -->
<p></p>
<!-- /wp:paragraph -->]]></content:encoded>
<excerpt:encoded><![CDATA[]]></excerpt:encoded>
<wp:post_id>13</wp:post_id>
<wp:post_date><![CDATA[2019-11-06 04:56:04]]></wp:post_date>
<wp:post_date_gmt><![CDATA[2019-11-06 04:56:04]]></wp:post_date_gmt>
<wp:comment_status><![CDATA[closed]]></wp:comment_status>
<wp:ping_status><![CDATA[closed]]></wp:ping_status>
<wp:post_name><![CDATA[manage-pledge]]></wp:post_name>
<wp:status><![CDATA[publish]]></wp:status>
<wp:post_parent>0</wp:post_parent>
<wp:menu_order>0</wp:menu_order>
<wp:post_type><![CDATA[page]]></wp:post_type>
<wp:post_password><![CDATA[]]></wp:post_password>
<wp:is_sticky>0</wp:is_sticky>
</item>
<item>
<title></title>
<link>http://five-for-the-future.test/?p=17</link>
<pubDate>Mon, 30 Nov -0001 00:00:00 +0000</pubDate>
<dc:creator><![CDATA[a]]></dc:creator>
<guid isPermaLink="false">http://five-for-the-future.test/?p=17</guid>
<description></description>
<content:encoded><![CDATA[ ]]></content:encoded>
<excerpt:encoded><![CDATA[]]></excerpt:encoded>
<wp:post_id>17</wp:post_id>
<wp:post_date><![CDATA[2019-11-06 04:58:48]]></wp:post_date>
<wp:post_date_gmt><![CDATA[0000-00-00 00:00:00]]></wp:post_date_gmt>
<wp:comment_status><![CDATA[closed]]></wp:comment_status>
<wp:ping_status><![CDATA[closed]]></wp:ping_status>
<wp:post_name><![CDATA[]]></wp:post_name>
<wp:status><![CDATA[draft]]></wp:status>
<wp:post_parent>0</wp:post_parent>
<wp:menu_order>1</wp:menu_order>
<wp:post_type><![CDATA[nav_menu_item]]></wp:post_type>
<wp:post_password><![CDATA[]]></wp:post_password>
<wp:is_sticky>0</wp:is_sticky>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_type]]></wp:meta_key>
<wp:meta_value><![CDATA[post_type]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_menu_item_parent]]></wp:meta_key>
<wp:meta_value><![CDATA[0]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_object_id]]></wp:meta_key>
<wp:meta_value><![CDATA[7]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_object]]></wp:meta_key>
<wp:meta_value><![CDATA[page]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_target]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_classes]]></wp:meta_key>
<wp:meta_value><![CDATA[a:1:{i:0;s:0:"";}]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_xfn]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_url]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_orphaned]]></wp:meta_key>
<wp:meta_value><![CDATA[1573016328]]></wp:meta_value>
</wp:postmeta>
</item>
<item>
<title></title>
<link>http://five-for-the-future.test/18/</link>
<pubDate>Wed, 06 Nov 2019 04:59:30 +0000</pubDate>
<dc:creator><![CDATA[a]]></dc:creator>
<guid isPermaLink="false">http://five-for-the-future.test/?p=18</guid>
<description></description>
<content:encoded><![CDATA[ ]]></content:encoded>
<excerpt:encoded><![CDATA[]]></excerpt:encoded>
<wp:post_id>18</wp:post_id>
<wp:post_date><![CDATA[2019-11-06 04:59:30]]></wp:post_date>
<wp:post_date_gmt><![CDATA[2019-11-06 04:59:30]]></wp:post_date_gmt>
<wp:comment_status><![CDATA[closed]]></wp:comment_status>
<wp:ping_status><![CDATA[closed]]></wp:ping_status>
<wp:post_name><![CDATA[18]]></wp:post_name>
<wp:status><![CDATA[publish]]></wp:status>
<wp:post_parent>0</wp:post_parent>
<wp:menu_order>1</wp:menu_order>
<wp:post_type><![CDATA[nav_menu_item]]></wp:post_type>
<wp:post_password><![CDATA[]]></wp:post_password>
<wp:is_sticky>0</wp:is_sticky>
<category domain="nav_menu" nicename="primary"><![CDATA[Primary]]></category>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_type]]></wp:meta_key>
<wp:meta_value><![CDATA[post_type]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_menu_item_parent]]></wp:meta_key>
<wp:meta_value><![CDATA[0]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_object_id]]></wp:meta_key>
<wp:meta_value><![CDATA[7]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_object]]></wp:meta_key>
<wp:meta_value><![CDATA[page]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_target]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_classes]]></wp:meta_key>
<wp:meta_value><![CDATA[a:1:{i:0;s:0:"";}]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_xfn]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_url]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
</item>
<item>
<title></title>
<link>http://five-for-the-future.test/19/</link>
<pubDate>Wed, 06 Nov 2019 04:59:30 +0000</pubDate>
<dc:creator><![CDATA[a]]></dc:creator>
<guid isPermaLink="false">http://five-for-the-future.test/?p=19</guid>
<description></description>
<content:encoded><![CDATA[ ]]></content:encoded>
<excerpt:encoded><![CDATA[]]></excerpt:encoded>
<wp:post_id>19</wp:post_id>
<wp:post_date><![CDATA[2019-11-06 04:59:30]]></wp:post_date>
<wp:post_date_gmt><![CDATA[2019-11-06 04:59:30]]></wp:post_date_gmt>
<wp:comment_status><![CDATA[closed]]></wp:comment_status>
<wp:ping_status><![CDATA[closed]]></wp:ping_status>
<wp:post_name><![CDATA[19]]></wp:post_name>
<wp:status><![CDATA[publish]]></wp:status>
<wp:post_parent>0</wp:post_parent>
<wp:menu_order>2</wp:menu_order>
<wp:post_type><![CDATA[nav_menu_item]]></wp:post_type>
<wp:post_password><![CDATA[]]></wp:post_password>
<wp:is_sticky>0</wp:is_sticky>
<category domain="nav_menu" nicename="primary"><![CDATA[Primary]]></category>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_type]]></wp:meta_key>
<wp:meta_value><![CDATA[post_type]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_menu_item_parent]]></wp:meta_key>
<wp:meta_value><![CDATA[0]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_object_id]]></wp:meta_key>
<wp:meta_value><![CDATA[9]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_object]]></wp:meta_key>
<wp:meta_value><![CDATA[page]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_target]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_classes]]></wp:meta_key>
<wp:meta_value><![CDATA[a:1:{i:0;s:0:"";}]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_xfn]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_url]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
</item>
<item>
<title></title>
<link>http://five-for-the-future.test/20/</link>
<pubDate>Wed, 06 Nov 2019 04:59:30 +0000</pubDate>
<dc:creator><![CDATA[a]]></dc:creator>
<guid isPermaLink="false">http://five-for-the-future.test/?p=20</guid>
<description></description>
<content:encoded><![CDATA[ ]]></content:encoded>
<excerpt:encoded><![CDATA[]]></excerpt:encoded>
<wp:post_id>20</wp:post_id>
<wp:post_date><![CDATA[2019-11-06 04:59:30]]></wp:post_date>
<wp:post_date_gmt><![CDATA[2019-11-06 04:59:30]]></wp:post_date_gmt>
<wp:comment_status><![CDATA[closed]]></wp:comment_status>
<wp:ping_status><![CDATA[closed]]></wp:ping_status>
<wp:post_name><![CDATA[20]]></wp:post_name>
<wp:status><![CDATA[publish]]></wp:status>
<wp:post_parent>0</wp:post_parent>
<wp:menu_order>3</wp:menu_order>
<wp:post_type><![CDATA[nav_menu_item]]></wp:post_type>
<wp:post_password><![CDATA[]]></wp:post_password>
<wp:is_sticky>0</wp:is_sticky>
<category domain="nav_menu" nicename="primary"><![CDATA[Primary]]></category>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_type]]></wp:meta_key>
<wp:meta_value><![CDATA[post_type]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_menu_item_parent]]></wp:meta_key>
<wp:meta_value><![CDATA[0]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_object_id]]></wp:meta_key>
<wp:meta_value><![CDATA[13]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_object]]></wp:meta_key>
<wp:meta_value><![CDATA[page]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_target]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_classes]]></wp:meta_key>
<wp:meta_value><![CDATA[a:1:{i:0;s:0:"";}]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_xfn]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_url]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
</item>
<item>
<title></title>
<link>http://five-for-the-future.test/21/</link>
<pubDate>Wed, 06 Nov 2019 04:59:30 +0000</pubDate>
<dc:creator><![CDATA[a]]></dc:creator>
<guid isPermaLink="false">http://five-for-the-future.test/?p=21</guid>
<description></description>
<content:encoded><![CDATA[ ]]></content:encoded>
<excerpt:encoded><![CDATA[]]></excerpt:encoded>
<wp:post_id>21</wp:post_id>
<wp:post_date><![CDATA[2019-11-06 04:59:30]]></wp:post_date>
<wp:post_date_gmt><![CDATA[2019-11-06 04:59:30]]></wp:post_date_gmt>
<wp:comment_status><![CDATA[closed]]></wp:comment_status>
<wp:ping_status><![CDATA[closed]]></wp:ping_status>
<wp:post_name><![CDATA[21]]></wp:post_name>
<wp:status><![CDATA[publish]]></wp:status>
<wp:post_parent>0</wp:post_parent>
<wp:menu_order>4</wp:menu_order>
<wp:post_type><![CDATA[nav_menu_item]]></wp:post_type>
<wp:post_password><![CDATA[]]></wp:post_password>
<wp:is_sticky>0</wp:is_sticky>
<category domain="nav_menu" nicename="primary"><![CDATA[Primary]]></category>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_type]]></wp:meta_key>
<wp:meta_value><![CDATA[post_type]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_menu_item_parent]]></wp:meta_key>
<wp:meta_value><![CDATA[0]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_object_id]]></wp:meta_key>
<wp:meta_value><![CDATA[11]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_object]]></wp:meta_key>
<wp:meta_value><![CDATA[page]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_target]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_classes]]></wp:meta_key>
<wp:meta_value><![CDATA[a:1:{i:0;s:0:"";}]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_xfn]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_url]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
</item>
<item>
<title>View Pledges</title>
<link>http://five-for-the-future.test/view-pledges/</link>
<pubDate>Wed, 06 Nov 2019 04:59:30 +0000</pubDate>
<dc:creator><![CDATA[a]]></dc:creator>
<guid isPermaLink="false">http://five-for-the-future.test/?p=22</guid>
<description></description>
<content:encoded><![CDATA[]]></content:encoded>
<excerpt:encoded><![CDATA[]]></excerpt:encoded>
<wp:post_id>22</wp:post_id>
<wp:post_date><![CDATA[2019-11-06 04:59:30]]></wp:post_date>
<wp:post_date_gmt><![CDATA[2019-11-06 04:59:30]]></wp:post_date_gmt>
<wp:comment_status><![CDATA[closed]]></wp:comment_status>
<wp:ping_status><![CDATA[closed]]></wp:ping_status>
<wp:post_name><![CDATA[view-pledges]]></wp:post_name>
<wp:status><![CDATA[publish]]></wp:status>
<wp:post_parent>0</wp:post_parent>
<wp:menu_order>5</wp:menu_order>
<wp:post_type><![CDATA[nav_menu_item]]></wp:post_type>
<wp:post_password><![CDATA[]]></wp:post_password>
<wp:is_sticky>0</wp:is_sticky>
<category domain="nav_menu" nicename="primary"><![CDATA[Primary]]></category>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_type]]></wp:meta_key>
<wp:meta_value><![CDATA[custom]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_menu_item_parent]]></wp:meta_key>
<wp:meta_value><![CDATA[0]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_object_id]]></wp:meta_key>
<wp:meta_value><![CDATA[22]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_object]]></wp:meta_key>
<wp:meta_value><![CDATA[custom]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_target]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_classes]]></wp:meta_key>
<wp:meta_value><![CDATA[a:1:{i:0;s:0:"";}]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_xfn]]></wp:meta_key>
<wp:meta_value><![CDATA[]]></wp:meta_value>
</wp:postmeta>
<wp:postmeta>
<wp:meta_key><![CDATA[_menu_item_url]]></wp:meta_key>
<wp:meta_value><![CDATA[/pledges]]></wp:meta_value>
</wp:postmeta>
</item>
</channel>
</rss>

View file

@ -5,18 +5,74 @@
The program encourages organizations to contribute five percent of their resources to WordPress development, to maintain a "golden ratio" of contributors to users.
## Contributing
In order to contribute with code changes, you'll want to set up a local environment to test changes and then push the changes to a Pull Request on this Github Repository.
### Initial environment setup
1. Use whichever local WordPress development setup you prefer and create a new local WP site.
1. 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).
1. Fork the [five-for-the-future](https://github.com/WordPress/five-for-the-future) repository under your own Github account.
1. 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.
1. Ensure this newly cloned `wp-content` folder is where it should be in the WP structure.
1. 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).
1. If you are making changes to the plugins, you can run `composer install` at `/wp-content/plugins/wporg-5ftf` and then `composer run test` to run the WP unit tests.
### Configuring the site
1. Login to your site and activate the "Five for the Future" theme and plugin.
1. Navigate to `/wp-content/themes/wporg-5ftf` and run: `npm install && npm run build`
### Setting up default data
1. Set your permalinks to "Post name" at `Settings > Permalinks`.
1. Run the WP XML Importer at `Tools > Import` and select `wp-content/.env/import.wxr`.
1. Set the Primary Menu at `Appearance > Menu`.
1. Set "About" as the static home page at `Settings > Reading`.
1. Add new Pledges on the "Add New Pledge" page. Note that you'll need to use valid WP usernames on your install.
1. Set the new entry to Published in the `Five For the Future > Pledges admin` area.
1. Find the "Sending email" log entry in the pledge admin and copy/paste the link in a new tab to confirm the email.
1. Go to the `Five For the Future > Contributors` page and publish the post(s) via quick edit.
1. Your new pledge should appear on the `/pledges/` pages now.
## Scripts
If you making changes to the theme's CSS, you can run `npm start` at `/wp-content/themes/wporg-5ftf` to watch for CSS changes and automatically compile.
If you are making changes to the plugins, you can run `composer update` at `/wp-content/plugins/wporg-5ftf` and then `composer run test` to run the WP unit tests. Run `composer test:watch` if you want to run the tests every time you change a file.
And lastly, you can run PHPCS for both the theme and the plugin at the root `/wp-content/` folder by running `composer install` there once, followed by `composer run phpcs` when you want to code scan.
* `composer run phpcs` - Lint the entire codebase
* `composer run phpcs -- -a themes/wporg-5ftf/` - Lint a specific folder, interactively
* `composer run phpcbf` - Fix linter warnings (when possible)
* `composer run test` - Run unit tests
* `composer run test:watch` - Run unit tests after each file change.
See [the theme README](./themes/wporg-5ftf/README.md) for scripts specific to the theme.
### Submitting Pull Requests
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` 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` branch clean and in sync with the upstream repository.
## Syncing to production
This is only relevant for committers; contributors don't need to worry about syncing.
The canonical source for this project is [github.com/WordPress/five-for-the-future](https://github.com/WordPress/five-for-the-future). The contents are synced to the dotorg SVN repo to run on production, because we don't deploy directly from GitHub, for reliability reasons.
The plugin and theme lives in the private SVN repo instead of `meta.svn.wordpress.org`, because the code is already open-sourced, and we don't want to clutter the Meta logs and Slack channels with noise from "Syncing w/ Git repository..." commits.