Skip to content

Commit 2d317ea

Browse files
n7studiosn7studios
authored
Merge pull request #58 from ConvertKit/1.0-beta
1.0
2 parents 7dd82ea + ac00175 commit 2d317ea

33 files changed

+5324
-2989
lines changed

‎.env.dist.testing‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
CONVERTKIT_API_BROADCAST_ID="8697158"
2+
CONVERTKIT_API_FORM_ID="2765139"
3+
CONVERTKIT_API_LEGACY_FORM_URL="https://app.convertkit.com/landing_pages/470099"
4+
CONVERTKIT_API_LANDING_PAGE_URL="https://cheerful-architect-3237.ck.page/cc5eb21744"
5+
CONVERTKIT_API_LEGACY_LANDING_PAGE_URL="https://app.convertkit.com/landing_pages/470103"
6+
CONVERTKIT_API_SEQUENCE_ID="1030824"
7+
CONVERTKIT_API_TAG_NAME="wordpress"
8+
CONVERTKIT_API_TAG_ID="2744672"
9+
CONVERTKIT_API_SUBSCRIBER_EMAIL="[email protected]"
10+
CONVERTKIT_API_SUBSCRIBER_ID="1579118532"

‎.env.example‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
CONVERTKIT_API_KEY_NO_DATA=
2+
CONVERTKIT_API_SECRET_NO_DATA=
3+
CONVERTKIT_API_KEY=
4+
CONVERTKIT_API_SECRET=
5+
CONVERTKIT_API_BROADCAST_ID="8697158"
6+
CONVERTKIT_API_FORM_ID="2765139"
7+
CONVERTKIT_API_LEGACY_FORM_URL="https://app.convertkit.com/landing_pages/470099"
8+
CONVERTKIT_API_LANDING_PAGE_URL="https://cheerful-architect-3237.ck.page/cc5eb21744"
9+
CONVERTKIT_API_LEGACY_LANDING_PAGE_URL="https://app.convertkit.com/landing_pages/470103"
10+
CONVERTKIT_API_SEQUENCE_ID="1030824"
11+
CONVERTKIT_API_TAG_NAME="wordpress"
12+
CONVERTKIT_API_TAG_ID="2744672"
13+
CONVERTKIT_API_SUBSCRIBER_EMAIL="[email protected]"
14+
CONVERTKIT_API_SUBSCRIBER_ID="1579118532"

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this bug report!
9+
- type: textarea
10+
id: what-happened
11+
attributes:
12+
label: Describe the bug
13+
description: A clear and concise description of what the bug is.
14+
placeholder: Tell us what you see!
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: repro-steps
19+
attributes:
20+
label: To Reproduce
21+
description: Steps to reproduce the behavior
22+
placeholder: |
23+
1. Fetch a '...'
24+
2. Update the '....'
25+
3. See error
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: expected-behavior
30+
attributes:
31+
label: Expected behavior
32+
description: A clear and concise description of what you expected to happen.
33+
validations:
34+
required: true
35+
- type: textarea
36+
id: code-snippets
37+
attributes:
38+
label: Code snippets
39+
description: If applicable, add code snippets to help explain your problem.
40+
render: PHP
41+
validations:
42+
required: false
43+
- type: input
44+
id: os
45+
attributes:
46+
label: OS
47+
placeholder: macOS
48+
validations:
49+
required: true
50+
- type: input
51+
id: language-version
52+
attributes:
53+
label: PHP version
54+
placeholder: PHP 8.1
55+
validations:
56+
required: true
57+
- type: input
58+
id: lib-version
59+
attributes:
60+
label: Library version
61+
placeholder: v1.0.0
62+
validations:
63+
required: true
64+
- type: textarea
65+
id: additional-context
66+
attributes:
67+
label: Additional context
68+
description: Add any other context about the problem here.
69+
validations:
70+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: ConvertKit support
4+
url: https://convertkit.com/support/
5+
about: |
6+
Please only file issues here that you believe represent actual bugs or feature requests for the ConvertKit PHP SDK.
7+
8+
If you're having general trouble with your ConvertKit integration, please reach out to support.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Feature request
2+
description: Suggest an idea for this PHP SDK
3+
labels: ["feature-request"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to fill out this feature request!
9+
- type: textarea
10+
id: problem
11+
attributes:
12+
label: Is your feature request related to a problem? Please describe.
13+
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
14+
- type: textarea
15+
id: solution
16+
attributes:
17+
label: Describe the solution you'd like
18+
description: A clear and concise description of what you want to happen.
19+
- type: textarea
20+
id: alternatives
21+
attributes:
22+
label: Describe alternatives you've considered
23+
description: A clear and concise description of any alternative solutions or features you've considered.
24+
- type: textarea
25+
id: context
26+
attributes:
27+
label: Additional context
28+
description: Add any other context about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Summary
2+
3+
A brief description of what this PR adds, changes or fixes.
4+
5+
If it is adding functionality, a use case of why this is needed helps determine its suitability.
6+
7+
## Testing
8+
9+
Not sure how to perform testing, or perhaps didn't include a test in this PR? Walk through the following in order for a beginner-friendly guide:
10+
- [Setup](SETUP.md) - setting up your local environment for development and testing
11+
- [Development](DEVELOPMENT.md) - best practices for development
12+
- [Testing](TESTING.md) - how to write and run tests
13+
14+
## Checklist
15+
16+
* [ ] I have [written a test](TESTING.md#writing-a-test) and included it in this PR
17+
* [ ] I have [run all tests](TESTING.md#run-tests) and they pass
18+
* [ ] The code passes when [running the PHP CodeSniffer](TESTING.md#run-php-codesniffer)
19+
* [ ] The code passes when [running PHPStan](TESTING.md#run-phpstan)
20+
* [ ] I have assigned a reviewer or two to review this PR (if you're not sure who to assign, we can do this step for you)

‎.github/docs/coding-standards.png‎

108 KB
Loading

‎.github/docs/new-release.png‎

180 KB
Loading

‎.github/docs/phpstan.png‎

99.4 KB
Loading

‎.github/phpdoc-template/class.md.twig‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
{% block content %}
2+
# {{ node.name }}
3+
4+
{% if node.summary %}{{ node.summary|raw }}{% endif %}
5+
{% if node.description %}{{ node.description|raw }}{% endif %}
6+
7+
* Full name: `{{ node.FullyQualifiedStructuralElementName }}`
8+
{% if node.parent and node.parent is not empty %}* Parent class: {{ macros.mdClassLink(node.parent, macros.mdClassPath(node), node.parent.FullyQualifiedStructuralElementName) }}
9+
{% endif %}
10+
{% if node.final %}* This class is marked as **final** and can't be subclassed
11+
{% endif %}
12+
{% if node.deprecated %}* **Warning:** this class is **deprecated**. This means that this class will likely be removed in a future version.
13+
{% endif %}
14+
{% if node.interfaces is not empty %}
15+
* This class implements:
16+
{% for interface in node.interfaces %}
17+
{% if loop.index0 > 0 %}{{ ', ' }}{% endif %}{{ macros.mdClassLink(interface, macros.mdClassPath(node), interface) }}{% endfor %}
18+
19+
{% endif %}
20+
{% if node.abstract %}* This class is an **Abstract class**
21+
{% endif %}
22+
{% if node.final %}* This class is a **Final class**
23+
{% endif %}
24+
25+
{% if node.tags.see is not empty or node.tags.link is not empty %}
26+
**See Also:**
27+
28+
{% for see in node.tags.see %}
29+
* {{ see.reference }} {% if see.description %}- {{ see.description|raw }}{% endif %}
30+
31+
{% endfor %}
32+
{% for link in node.tags.link %}
33+
* {{ link.link }} {% if link.description and link.description != link.link %}- {{ link.description|raw }}{% endif %}
34+
35+
{% endfor %}
36+
37+
{% endif %}{# node.tags.see || node.tags.link #}
38+
{% if node.constants | length > 0 %}
39+
## Constants
40+
41+
| Constant | Visibility | Type | Value |
42+
|:---------|:-----------|:-----|:------|
43+
{% for constant in node.constants %}
44+
|`{{constant.name}}`|{{ constant.visibility | default('*default*') }}|{{constant.type | default(' ')}}|{{constant.value}}|
45+
{% endfor %}
46+
{% endif %}
47+
{% if node.properties | length > 0 %}
48+
## Properties
49+
50+
{% for property in node.properties %}
51+
{% include 'property.md.twig' %}
52+
{% endfor %}
53+
{% endif %}
54+
{% if node.methods|length > 0 %}
55+
## Methods
56+
57+
{% for method in node.methods %}
58+
{% include 'method.md.twig' %}
59+
{% endfor %}
60+
{% endif %}{# if methods #}
61+
62+
{% if node.InheritedMethods|length > 0 %}
63+
## Inherited methods
64+
65+
{% for method in node.InheritedMethods %}
66+
{% include 'method.md.twig' %}
67+
{% endfor %}
68+
69+
{% endif %}{# if InheritedMethods #}
70+
71+
{% endblock %}

0 commit comments

Comments
 (0)