Skip to content

Commit

Permalink
Update composer.json and docs (#37)
Browse files Browse the repository at this point in the history
* Update composer.json
 * Support for Lingo 3.0
 * Update of info

* Create docs dir and add issue + PR templates
  • Loading branch information
s7eph4n committed Mar 24, 2018
1 parent 2fad044 commit 94847ea
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 3 deletions.
1 change: 1 addition & 0 deletions RELEASE-NOTES.md
Expand Up @@ -6,6 +6,7 @@ Released on 2018-????.

* Compatibility with Semantic MediaWiki 3.0
* Compatibility with MediaWiki 1.31
* Compatibility with Lingo 3.0

### 2.2.0

Expand Down
10 changes: 7 additions & 3 deletions composer.json
Expand Up @@ -18,20 +18,24 @@
"name": "Stephan Gambke",
"email": "s7eph4n@gmail.com",
"role": "Developer"
},
{
"name": "James Hong Kong",
"role": "Developer"
}
],
"support": {
"wiki": "https://www.mediawiki.org/wiki/Extension:Semantic_Glossary",
"forum": "https://www.mediawiki.org/wiki/Extension_talk:Semantic_Glossary",
"source": "https://github.com/SemanticMediaWiki/SemanticGlossary.git",
"issues": "https://bugzilla.wikimedia.org/buglist.cgi?component=SemanticGlossary&product=MediaWiki%20extensions",
"issues": "https://github.com/SemanticMediaWiki/SemanticGlossary/issues",
"irc": "irc://irc.freenode.org/semantic-mediawiki"
},
"require": {
"php": ">=5.3.3",
"composer/installers":"^1.0.12",
"mediawiki/semantic-media-wiki": "~2.4|~3.0",
"mediawiki/lingo": "^2.0.3"
"mediawiki/semantic-media-wiki": "^2.4|^3.0",
"mediawiki/lingo": "^2.0.3|^3.0"
},
"extra": {
"branch-alias": {
Expand Down
15 changes: 15 additions & 0 deletions docs/CONTRIBUTING.md
@@ -0,0 +1,15 @@
If you would like to make a contribution to [Semantic Glossary][sg], please ensure that pull requests are based on the current master.

In order to swiftly coordinate a contribution, the following should be provided:
- Code should be easily read and if necessary be put into separate components (or classes)
- Newly added features should not alter an existing test but instead provide additional test coverage to verify the expected behaviour

For a description on how to write and run PHPUnit test, please consult the [manual][mw-testing].

### Reporting an issue

If you report an issue, please ensure to use the current master (this helps to verify that the problem still persists and isn't solved already) and describe your environment (SMW, MW version etc.) together with a [stack trace][stack-trace] and a clear description on how to reproduce it.

[sg]: https://github.com/SemanticMediaWiki/SemanticGlossary
[mw-testing]: https://www.mediawiki.org/wiki/Manual:PHP_unit_testing
[stack-trace]: https://semantic-mediawiki.org/wiki/Stack_trace
17 changes: 17 additions & 0 deletions docs/ISSUE_TEMPLATE.md
@@ -0,0 +1,17 @@
### Setup and configuration

- MW version:
- PHP version:
- DB (MySQL etc.):
- SMW version:
- SG version:
- Lingo version:

### Issue

Produces a [stack trace](https://www.semantic-mediawiki.org/wiki/Help:Identifying_bugs) and outputs:

```
```

Steps to reproduce the observation (recommendation is to use the [sandbox](https://sandbox.semantic-mediawiki.org)):
11 changes: 11 additions & 0 deletions docs/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,11 @@
This PR is made in reference to: #

This PR addresses or contains:
- ...
- ...
- ...

This PR includes:
- [ ] Update of RELEASE-NOTES.md
- [ ] Tests (unit/integration)
- [ ] CI build passed

0 comments on commit 94847ea

Please sign in to comment.