Skip to content

Commit 74eb2cf

Browse files
committed
Initial commit
0 parents  commit 74eb2cf

File tree

6 files changed

+105
-0
lines changed

6 files changed

+105
-0
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
hashes.json
2+
_build/
3+
_releases/
4+
_data/

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing to PostTOC
2+
3+
## First setup
4+
5+
1. You need [XenForo 2.x](https://xenforo.com/). You can setup a Scotch Box
6+
environment as described in the [Xenforo 2.x Development
7+
Documentation](https://xenforo.com/xf2-docs/dev/scotchbox/)
8+
2. Fork TwitchPiper
9+
3. Move in the `src/addon/` folder of your development enviroment and `mkdir Inforge && cd Inforge`
10+
4. `git clone https://github.com/<your-username>/PostTOC && cd PostTOC`
11+
5. `git remote add upstream https://github.com/InforgeNet/PostTOC`
12+
13+
## Pull request
14+
15+
Each time you want to submit a pull request, do the following:
16+
17+
1. Download latest upstream modifications: `git fetch upstream`
18+
2. Ceate a new branch: `git checkout -b whatever-you-want-feature upstream/master`
19+
3. Make you changes, add them and commit
20+
4. `git push -u origin whatever-you-want-feature`
21+
5. Visit `https://github.com/<your-username>/PostTOC` and create a new pull request
22+
23+
### Commit message
24+
25+
Follow these guidelines to write a proper commit message: [How to Write a Git
26+
Commit Message](https://chris.beams.io/posts/git-commit/).
27+
28+
### Code style
29+
30+
General guidelines:
31+
32+
* Indent code with a **single tab**
33+
* Avoid brackets when they are not necessary
34+
* Try to keep lines under 80 columns, assuming a tab width equal to 8 spaces
35+
(yes!)
36+
* Follow the [XenForo 2.x](https://xenforo.com/xf2-docs/dev/) code style
37+
conventions
38+
* In general, I like the [Linux Kernel Coding
39+
Style](https://www.kernel.org/doc/html/latest/process/coding-style.html) and
40+
try to adapt it to PHP, JS and every other C-like language
41+
* Check out the code already in the repository and try to follow the same style
42+
* Use common sense

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Niccolò Scatena (Inforge)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
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
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# PostTOC

Setup.php

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<?php
2+
3+
namespace Inforge\PostTOC;
4+
5+
use XF\AddOn\AbstractSetup;
6+
use XF\AddOn\StepRunnerInstallTrait;
7+
use XF\AddOn\StepRunnerUninstallTrait;
8+
use XF\AddOn\StepRunnerUpgradeTrait;
9+
10+
class Setup extends AbstractSetup
11+
{
12+
use StepRunnerInstallTrait;
13+
use StepRunnerUpgradeTrait;
14+
use StepRunnerUninstallTrait;
15+
}

addon.json

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"legacy_addon_id": "",
3+
"title": "[Inforge] PostTOC",
4+
"description": "Add BBCode to support the creation of a table of contents in posts.",
5+
"version_id": 1000070,
6+
"version_string": "1.0.0",
7+
"dev": "Inforge",
8+
"dev_url": "https://www.inforge.net",
9+
"faq_url": "https://github.com/InforgeNet/PostTOC/wiki/Frequently-Asked-Questions",
10+
"support_url": "https://github.com/InforgeNet/PostTOC/issues",
11+
"extra_urls": {
12+
"Forum": "https://www.inforge.net/forum",
13+
"GitHub": "https://github.com/InforgeNet/PostTOC"
14+
},
15+
"require": {
16+
"XF": [
17+
2020010,
18+
"XenForo 2.2.0+"
19+
]
20+
},
21+
"icon": "fas fa-list"
22+
}

0 commit comments

Comments
 (0)