Skip to content

Commit d44614a

Browse files
philwarehamphilwareham
committed
Add initial files/placeholders
1 parent 4a5d0b9 commit d44614a

12 files changed

+283
-1
lines changed

‎.github/CODE_OF_CONDUCT.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our standards
8+
9+
Examples of behaviour that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behaviour by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behaviour and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behaviour.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviours that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), [version 1.4](http://contributor-covenant.org/version/1/4/).

‎.github/ISSUE_TEMPLATE/add-a-missing-textpattern-theme.md

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Add a missing Textpattern theme
3+
about: Use this form to suggest a Textpattern theme to be added to the themes website.
4+
title: "[ADD] xxxxx"
5+
labels: theme-add
6+
---
7+
8+
**Note:** Please ensure you have read the [README](https://github.com/textpattern/textpattern-curated-themes-list/blob/master/README.md) file prior to filing this issue.
9+
10+
**Name of theme**
11+
12+
xxxxx
13+
14+
**Please complete as much of the JSON template below as is possible/relevant**
15+
16+
```json
17+
{
18+
"name": "{prefix_theme-name}",
19+
"repositories": [
20+
{
21+
"repoType": "{homepage-github-bitbucket-gitlab}",
22+
"repoUrl": "{url-of-repo-project}"
23+
},
24+
{
25+
"repoType": "{homepage-github-bitbucket-gitlab}",
26+
"repoUrl": "{url-of-repo-project}"
27+
}
28+
],
29+
TODO
30+
}
31+
```
32+
33+
**Textpattern min compatibility of latest theme version, if known**
34+
35+
Minimum Textpattern version compatibility:
36+
37+
- [ ] 4.8
38+
- [ ] 4.7
39+
40+
**URL of theme demo, if available**
41+
42+
{url-of-theme-demo}
43+
44+
**Brief description of theme (optional)**

‎.github/ISSUE_TEMPLATE/config.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: themes.textpattern.com website issue
3+
url: https://github.com/textpattern/textpattern-themes-website/issues/new?template=report-a-website-issue.md
4+
about: Create a report to help us improve the Textpattern theme website (not specifically related to a theme listing).

‎.github/ISSUE_TEMPLATE/report-a-broken-textpattern-theme-listing.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Report a broken Textpattern theme listing
3+
about: Use this form to report a broken Textpattern theme listed on the themes website.
4+
title: "[BROKEN] xxxxx"
5+
labels: theme-broken
6+
---
7+
8+
**Note:** This form is intended for use when reporting broken theme links or unreachable content on the Textpattern themes website itself *not* theme code. In the event of broken theme code please contact the original author directly.
9+
10+
**Textpattern themes website page URL**
11+
12+
https://themes.textpattern.com/themes/xxxxx
13+
14+
**Please give a brief description of what is broken**
15+
16+
xxxxx

‎.github/ISSUE_TEMPLATE/update-an-existing-textpattern-theme.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Update info for an existing Textpattern theme
3+
about: Use this form to update information for an existing Textpattern theme within the themes website.
4+
title: "[UPDATE] xxxxx"
5+
labels: theme-add
6+
---
7+
8+
**Name of theme**
9+
10+
xxxxx
11+
12+
**Requested changes**
13+
14+
Version:
15+
16+
{semver}
17+
18+
Release date:
19+
20+
{yyyy}-{mm}-{dd}
21+
22+
Download URL of source code:
23+
24+
{url-of-theme-code}
25+
26+
URL of theme demo, if available:
27+
28+
{url-of-theme-demo}
29+
30+
**Textpattern min compatibility of latest theme version, if known**
31+
32+
Minimum Textpattern version compatibility:
33+
34+
- [ ] 4.8
35+
- [ ] 4.7

‎.github/PULL_REQUEST_TEMPLATE.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
For additions to the theme list, please ensure you follow the JSON file structure as outlined in the [README](https://github.com/textpattern/textpattern-curated-themes-list/blob/master/README.md) file of this repo.
2+
3+
Changes proposed in this pull request:
4+
5+
- {Please write here}
6+
- {Please write here}
7+
- {Please write here}

‎.gitignore

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# OS generated files #
2+
######################
3+
.DS_Store
4+
.DS_Store?
5+
._*
6+
.Spotlight-V100
7+
.Trashes
8+
Icon?
9+
ehthumbs.db
10+
Thumbs.db
11+
12+
# Development files #
13+
######################
14+
/node_modules
15+
/package-lock.json
16+
/npm-debug.log
17+
/yarn.lock
18+
/yarn-error.log

‎.travis.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
language: node_js
2+
node_js:
3+
- "14"
4+
sudo: false
5+
cache:
6+
directories:
7+
- "$HOME/.npm"

‎LICENSE

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
3+
Copyright (C) 2020 Team Textpattern
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a
6+
copy of this software and associated documentation files (the "Software"),
7+
to deal in the Software without restriction, including without limitation
8+
the rights to use, copy, modify, merge, publish, distribute, sublicense,
9+
and/or sell copies of the Software, and to permit persons to whom the
10+
Software is furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
19+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

+68-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,68 @@
1-
# textpattern-curated-themes-list
1+
# textpattern-curated-themes-list
2+
3+
[![Build Status](https://travis-ci.com/textpattern/textpattern-curated-themes-list.svg?branch=master)](https://travis-ci.com/textpattern/textpattern-curated-themes-list)
4+
5+
A curated list of [Textpattern CMS](https://textpattern.com) themes listed in the [Textpattern themes website](https://github.com/textpattern/textpattern-themes-website).
6+
7+
## JSON structure
8+
9+
Each theme has a JSON-formatted 'library card', located within the `library-of-themes` directory of this repository.
10+
11+
The Textpattern themes website digests the information for each card to provide the relevant details of the theme. Each card expects a set of [required entries](#required-entries) plus any [optional entries](#optional-entries) as appropriate. **It is recommended** that you complete as many fields as possible in the JSON file, as this helps provide the most information to users within the Textpattern themes site and assists with ongoing maintenance.
12+
13+
```JSON
14+
{
15+
"name": "example",
16+
"repositories": [
17+
{
18+
"repoType": "homepage",
19+
"repoUrl": "https://example.com/abc_example.html"
20+
},
21+
{
22+
"repoType": "github",
23+
"repoUrl": "https://github.com/exampleuser/abc_example"
24+
},
25+
{
26+
"repoType": "bitbucket",
27+
"repoUrl": "https://bitbucket.org/exampleuser/abc_example"
28+
},
29+
{
30+
"repoType": "gitlab",
31+
"repoUrl": "https://gitlab.com/exampleuser/abc_example"
32+
}
33+
],
34+
TODO
35+
}
36+
```
37+
38+
A [JSON template](https://raw.githubusercontent.com/textpattern/textpattern-curated-themes-list/master/template.json) is provided as a useful starting point.
39+
40+
### Required entries
41+
42+
TODO
43+
44+
### Example minimum structure
45+
46+
TODO
47+
48+
### Optional (but recommended) entries
49+
50+
TODO
51+
52+
### Manifests for themes
53+
54+
TODO
55+
56+
### Linting
57+
58+
You can run a linter over the JSON files to check validity as follows (requires [Node.js](https://nodejs.org/)):
59+
60+
```ShellSession
61+
$ cd textpattern-curated-themes-list
62+
$ npm install
63+
$ npm run jsonlint
64+
```
65+
66+
## License
67+
68+
Licensed under [MIT license](https://github.com/textpattern/textpattern-curated-themes-list/blob/master/LICENSE).

‎package.json

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"name": "textpattern-curated-themes-list",
3+
"description": "A curated list of Textpattern themes, in JSON format.",
4+
"version": "0.0.0",
5+
"repository": {
6+
"type": "git",
7+
"url": "https://github.com/textpattern/textpattern-curated-themes-list"
8+
},
9+
"bugs": {
10+
"url": "https://github.com/textpattern/textpattern-curated-themes-list/issues"
11+
},
12+
"devDependencies": {
13+
"@prantlf/jsonlint": "10.2.0"
14+
},
15+
"scripts": {
16+
"jsonlint": "jsonlint -q library-of-themes/*.json",
17+
"test": "npm run jsonlint"
18+
},
19+
"license": "MIT"
20+
}

‎template.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
TODO

0 commit comments

Comments
 (0)