Merge pull request #27 from kimcoleman/dev

Adding github template files, banner, README.md; Version .4.1 and rea…

.gitattributes

@@ -0,0 +1,5 @@
+# Items to ignore when downloading a zip
+pmpro-affiliates-banner.jpg export-ignore
+.gitattributes export-ignore
+.github export-ignore
+README.md export-ignore

.github/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contribute to Paid Memberships Pro
+
+Paid Memberships Pro is the "community solution" for membership sites on WordPress, and so contributions of all kinds are appreciated.
+
+When contributing, please follow these guidelines to ensure things work as smoothly as possible.
+
+__Please Note:__ GitHub is for bug reports and contributions only. If you have a support or customization question, go to our [Member Support Page](https://www.paidmembershipspro.com/support/) instead.
+
+## Getting Started
+
+* __Do not report potential security vulnerabilities here. Email them privately to [[email protected]](mailto:[email protected]) with the words "Security Vulnerability" in the subject.__
+* Submit a ticket for your issue, assuming one does not already exist.
+  * Raise it on our [Issue Tracker](https://github.com/strangerstudios/pmpro-affiliates/issues/new/choose)
+  * Clearly describe the issue including steps to reproduce the bug.
+  * Make sure you fill in the earliest version that you know has the issue as well as the version of WordPress you're using.
+
+## Making Changes
+
+* Fork the repository on GitHub
+* For bug fixes, checkout the DEV branch of the PMPro repository.
+* For new features and enhancements, checkout the branch for the version the feature is milestoned for.
+* Make sure to pull in any "upstream" changes first.
+	* Use `git remote add upstream https://github.com/strangerstudios/pmpro-affiliates.git` to set the upstream repo
+	* Use `git checkout dev` to get on the development branch.
+	* Use `git pull upstream dev` to get the latest updates.
+	* Use `git push` to push those updates to your fork.
+* Create a new local branch for each separate bug fix or feature. This will ensure that each pull request is for one issue only and easier to process.
+	* Use `git checkout -b nameofmybugfixorfeature` to create the new branch
+* Make the changes to your local repository.
+* Ensure you stick to the [WordPress Coding Standards](https://codex.wordpress.org/WordPress_Coding_Standards) (even though much of the PMPro code does not currently)
+* If you have an automatic beautifier in your IDE or dev environment, turn it off. Unrelated style changes in your pull requests will make them harder to process. Feel free to message the core development team to ask them to clean up a file you are working on if the inconsitent coding styles is bothering you.
+* You can update the readme.txt to include a comment about your fix or feature in the changelog, but if you do not the core team will do it for you.
+* When committing, reference your issue (if present) and include a note about the fix in the commit message.
+* Push the changes to your fork.
+* For bug fixes, submit a pull request to the DEV branch of the PMPro repository.
+* For new features and enhancements, submit a pull request to the version the feature is milestoned for. This will usually be the version number following the current release unless the core dev team has milestoned the feature for a later release.
+* We will process all pull requests and make suggestions or changes as soon as possible. Feel free to ping us politely via email or social networks to take a look at your pulls.
+
+## Code Documentation
+
+* We would like for every function, filter, class, and class method to be documented using phpDoc standards.
+* An example of [how PMPro uses phpDoc blocks can be found here](https://gist.github.com/sunnyratilal/5308969).
+* Please make sure that every function is documented so that when we update our API Documentation things don't go awry!
+	* If you're adding/editing a function in a class, make sure to add `@access {private|public|protected}`
+* Finally, please use tabs and not spaces. The tab indent size should be 4 for all Paid Memberships Pro code.
+
+# Additional Resources
+* [General GitHub Documentation](https://help.github.com/)
+* [GitHub Pull Request documentation](https://help.github.com/send-pull-requests/)

.github/ISSUE_TEMPLATE.MD

@@ -0,0 +1,45 @@
+<!-- This form is for reporting bugs and issues specific to the Paid Memberships Pro plugin. This is not a support portal. If you need technical support from a human being, please submit a ticket via the helpdesk instead: https://www.paidmembershipspro.com/support/ -->
+
+<!-- Usage questions can also be directed to the public support forum here: https://wordpress.org/support/plugin/paid-memberships-pro, unless this is a question about a premium extension in which case you should use the helpdesk. -->
+
+<!-- If you are a developer who needs a new filter/hook raise a PR instead :) -->
+
+<!-- Please be as descriptive as possible; issues lacking the below details, or for any other reason than to report a bug, may be closed without action. -->
+
+## Prerequisites
+
+<!-- MARK COMPLETED ITEMS WITH AN [x] -->
+
+- [ ] I have searched for similar issues in both open and closed tickets and cannot find a duplicate.
+- [ ] The issue still exists against the latest `dev` branch of Paid Memberships Pro on Github (this is **not** the same version as on WordPress.org!)
+- [ ] I have attempted to find the simplest possible steps to reproduce the issue
+
+## Steps to reproduce the issue
+
+<!-- We need to be able to reproduce the bug in order to fix it so please be descriptive! -->
+
+1.
+2.
+3.
+
+## Expected/actual behavior
+
+When I follow those steps, I see...
+
+I was expecting to see...
+
+## Isolating the problem
+
+<!-- MARK COMPLETED ITEMS WITH AN [x] -->
+
+- [ ] This bug happens with only Paid Memberships Pro plugin active
+- [ ] This bug happens with a default WordPress theme active, or [Memberlite](https://wordpress.org/themes/memberlite/)
+- [ ] I can reproduce this bug consistently using the steps above
+
+## WordPress Environment
+
+<details>
+```
+Please share non-sensitive information about your hosting environment such as WordPress version, PHP version, Paid Memberships Pro and any related plugins versions.
+```
+</details>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,36 @@
+---
+name: "🐛 Bug Report"
+about: Report a bug if something isn't working as expected in Paid Memberships Pro.
+title: ''
+labels: 'bug'
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is. Please be as descriptive as possible; issues lacking detail, or for any other reason than to report a bug, may be closed or left unattended.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Screenshots**
+If applicable, please attach a screenshot to make your issue clearer.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Isolating the problem (mark completed items with an [x]):**
+- [ ] I have deactivated other plugins and confirmed this bug occurs when only Paid Memberships Pro plugin is active.
+- [ ] This bug happens with a default WordPress theme active, or [Memberlite](https://wordpress.org/themes/memberlite/).
+- [ ] I can reproduce this bug consistently using the steps above.
+
+**WordPress Environment**
+<details>
+```
+Please share non-sensitive information about your hosting environment such as WordPress version, PHP version, Paid Memberships Pro and any related plugins versions.
+```
+</details>

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,21 @@
+---
+name: "⭐️ Enhancement"
+about: If you have an idea to improve an existing feature or need something
+  for development (such as a new hook) please let us know or submit a Pull Request.
+title: ''
+labels: 'enhancement'
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+If applicable, add any other context or screenshots about the enhancement here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: "➕ Feature Request"
+about: "Suggest a new feature. We'll consider building it if it receives
+  sufficient interest!"
+title: ''
+labels: 'feature request'
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+If applicable, add any other context or screenshots about your feature request here.

.github/ISSUE_TEMPLATE/support.md

@@ -0,0 +1,20 @@
+---
+name: "💬 Support Question"
+about: "If you have a question, please see our docs or use our helpdesk."
+title: ''
+labels: 'Type: support'
+assignees: ''
+
+---
+
+We don't offer technical support on GitHub so we recommend using the following:
+
+**Reading our documentation**
+Usage docs can be found here: https://www.paidmembershipspro.com/documentation/
+
+**Technical support for premium extensions or if you're a Paid Memberships Pro Plus member**
+Submit a ticket on our helpdesk by visiting https://www.paidmembershipspro.com/new-topic/ (Please note that an [active membership] (https://www.paidmembershipspro.com/pricing) is required for paid support.)
+
+**General usage and development questions**
+- WordPress.org Forums: https://wordpress.org/support/plugin/paid-memberships-pro
+- Website: https://www.paidmembershipspro.com/contact/

.github/PULL_REQUEST_TEMPLATE.MD

@@ -0,0 +1,32 @@
+### All Submissions:
+
+* [ ] Have you followed the [Contributing guidelines](https://github.com/strangerstudios/pmpro-affiliates/blob/dev/.github/CONTRIBUTING.md)?
+* [ ] Does your code follow the [WordPress' coding standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/)?
+* [ ] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/strangerstudios/pmpro-affiliates/pulls/) for the same update/change?
+
+<!-- Mark completed items with an [x] -->
+
+<!-- You can erase any parts of this template not applicable to your Pull Request. -->
+
+### Changes proposed in this Pull Request:
+
+<!-- Describe the changes made to this Pull Request and the reason for such changes. -->
+
+Resolves XXX.
+
+### How to test the changes in this Pull Request:
+
+1.
+2.
+3.
+
+### Other information:
+
+* [ ] Have you added an explanation of what your changes do and why you'd like us to include them?
+* [ ] Have you successfully run tests with your changes locally?
+
+<!-- Mark completed items with an [x] -->
+
+### Changelog entry
+
+> Enter a summary of all changes on this Pull Request. This will appear in the changelog if accepted.

README.md

@@ -0,0 +1,40 @@
+![](pmpro-affiliates-banner.jpg)
+
+# [Paid Memberships Pro - Affiliates](https://www.paidmembershipspro.com/add-ons/pmpro-lightweight-affiliate-tracking/) #
+[comment]: # (Generate badges from shields.io, only works for .org plugins to get other stats etc. We'd have to create our own endpoints for Premium plugins)
+
+![License](https://img.shields.io/badge/license-GPL--2.0%2B-red.svg?style=flat-square)
+
+### Welcome to the Paid Memberships Pro - Affiliates GitHub Repository
+
+The Lightweight Affiliate Tracking Add On for Paid Memberships Pro creates unique affiliate codes assigned to your affiliate users. When someone visits your site using an affiliate URL (a code is passed to a page as a parameter), the affiliate's cookie is set for the specified number of days. If a cookie containing an affiliate referral code is present after checkout, the order is logged in the affiliate's account.
+
+Affiliates can see a report of their activity by creating a page (optional) with the shortcode [pmpro_affiliates_report]. The admin can view a report of affiliate activity in the admin under Memberships > Affiliates as well as add and manage affiliate codes.
+
+For more information please visit [the Add On documentation page for this plugin](https://www.paidmembershipspro.com/add-ons/pmpro-lightweight-affiliate-tracking/).
+
+## Installation ##
+For detailed installation steps, visit the [documentation](https://www.paidmembershipspro.com/add-ons/pmpro-lightweight-affiliate-tracking/) page.
+
+1. Download the current development ZIP file directly: `https://github.com/strangerstudios/pmpro-affiliates/archive/dev.zip`
+
+**Please ensure that once installing this version of the plugin to remove `-dev` from the plugin's folder name.**
+
+## Bugs ##
+If you find an issue/bug, let us know by [creating a detailed GitHub issue](https://github.com/strangerstudios/pmpro-affiliates/issues/new/choose).
+
+## Support ##
+This is a developer's portal for Paid Memberships Pro - Affiliates. We do not offer support on this channel. **Any support related questions should be directed to [our website](https://www.paidmembershipspro.com/add-ons/pmpro-lightweight-affiliate-tracking/).**
+
+## Contributing to Paid Memberships Pro - Affiliates ##
+We encourage and welcome any contribution to Paid Memberships Pro - Affiliates. Please read the [guidelines for contributing](https://github.com/strangerstudios/pmpro-affiliates/blob/dev/.github/CONTRIBUTING.md) to this repository.
+
+There are various **ways to the help development** of Paid Memberships Pro - Affiliates:
+
+1. Report [bugs/issues](https://github.com/strangerstudios/pmpro-affiliates/issues/new/choose) on GitHub.
+2. Work on any issues by submitting a Pull Request.
+
+Here are some ways for **non-developers to contribute** to Paid Memberships Pro - Affiliates:
+
+1. Translate Paid Memberships Pro - Affiliates into your own [language](https://www.paidmembershipspro.com/paid-memberships-pro-in-your-language/).
+2. [Purchase a Plus membership](https://paidmembershipspro.com/pricing) to help fund ongoing development and bug fixes.

readme.txt

@@ -2,8 +2,8 @@
 Contributors: strangerstudios
 Tags: pmpro, paid memberships pro, ecommerce, affiliates
 Requires at least: 4.5
-Tested up to: 5.4.2
-Stable tag: 0.4
+Tested up to: 5.6
+Stable tag: 0.4.1
 
 Create affiliate accounts with unique referrer URLs to track membership checkouts.
 
@@ -46,6 +46,13 @@ Please visit our premium support site at http://www.paidmembershipspro.com for m
 
 == Changelog ==
 
+= 0.4.1 - 2021-01-19 =
+* BUG FIX/ENHANCEMENT: Adjusted queries to only include credit for orders not in specific statuses.
+* ENHANCEMENT: Added `pmpro_affiliates_new_code` filter to allow custom code to modifty the generated Affiliate Codes.
+* ENHANCEMENT: Now generating the affiliate codes using the pmpro_getDiscountCode function.
+* ENHANCEMENT: Localized the plugin for translation.
+* ENHANCEMENT: Added 'Membership Level' to the Affiliate Report admin page and export CSV.
+
 = 0.4 - 2020-07-13 =
 * BUG FIX: Fixed issue where recurring orders weren't tracked as affiliate sales even if you set an affiliate to get credit for renewals.
 * BUG FIX: No longer overriding the default character set when adding the DB tables on install.