mirror of
https://code.mensbeam.com/MensBeam/Arsse.git
synced 2024-12-22 21:22:40 +00:00
Added CONTRIBUTING.md
- Started on a contribution aid for contributors; it needs more work. - Changed the type in composer.json to “project”. - Made mention of The Arsse in the readme file more consistent.
This commit is contained in:
parent
14951e2e4f
commit
5f66f3c8de
3 changed files with 46 additions and 4 deletions
42
CONTRIBUTING.md
Normal file
42
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,42 @@
|
||||||
|
[a]: https://code.mensbeam.com/MensBeam/Policy/src/master/CODE-OF-CONDUCT.md
|
||||||
|
[b]: https://code.mensbeam.com/MensBeam/arsse/issues
|
||||||
|
[c]: http://www.php-fig.org/psr/psr-2/
|
||||||
|
|
||||||
|
# Contributing to The Arsse
|
||||||
|
|
||||||
|
We would love for you to contribute to our little project and to make The Arsse better. Here are the guidelines we would like you to follow:
|
||||||
|
|
||||||
|
* [Code of Conduct](#code-of-conduct)
|
||||||
|
* [Questions, Bugs, & Feature Requests](#questions-bugs-features)
|
||||||
|
* [Submission Guidelines](#submission-guidelines)
|
||||||
|
* [Coding Rules](#coding-rules)
|
||||||
|
|
||||||
|
## <a name="code-of-conduct"></a> Code of Conduct
|
||||||
|
|
||||||
|
We strive to keep The Arsse open and inclusive. Please read our [Code of Conduct][a] and follow its guidelines when interacting with others within this community.
|
||||||
|
|
||||||
|
## <a name="questions-issues-bugs-features"></a> Questions, Bugs & Feature Requests
|
||||||
|
|
||||||
|
Questions about how to use The Arsse, bugs, or feature requests can be directed at the [issues page][b].
|
||||||
|
|
||||||
|
## <a name="submission-guidelines"></a> Submission Guidelines
|
||||||
|
|
||||||
|
### Submitting an issue
|
||||||
|
|
||||||
|
Before you submit your issue search the archive to see if your question has been answered for you already. If your issue is new and hasn't been reported open a new issue; please do not report duplicate issues. We would like for you to provide the following information with each issue as it helps us help you:
|
||||||
|
|
||||||
|
1. *Overview* – Always submit stack traces if the bug produces one.
|
||||||
|
2. *Versions* – What version of The Arsse, php, and operating system are you using?
|
||||||
|
3. *Reproduce* - Provide a set of steps to reproduce the issue.
|
||||||
|
4. *Related* - Provide any issues you think might be related.
|
||||||
|
5. *Suggestions* - If you cannot fix the bug yourself provide any suggestions for fixing the issue.
|
||||||
|
|
||||||
|
### Submitting a Pull Request
|
||||||
|
|
||||||
|
Before you submit your pull request search for an existing open or closed pull request. Please refrain from duplicating pull requests.
|
||||||
|
|
||||||
|
## <a name="coding-rules"></a> Coding Rules
|
||||||
|
|
||||||
|
We would like to ensure consistency in our source code, so we follow the [PSR-2 guidelines][c] with one notable exception (utilizing the notation used and outlined in the original document):
|
||||||
|
|
||||||
|
**Opening braces for classes and methods MUST go on the same line, and closing braces MUST go on the next line after the body.**
|
|
@ -1,6 +1,6 @@
|
||||||
# The Advanced RSS Environment
|
# The Advanced RSS Environment
|
||||||
|
|
||||||
The Arsse is a news aggregator server which implements [version 1.2](https://github.com/nextcloud/news/blob/master/docs/externalapi/Legacy.md) of [NextCloud News](https://github.com/nextcloud/news)' client-server synchronization protocol. Unlike most other aggregator servers, the Arsse does not include a Web front-end (though one is planned as a separate project), and it relies on existing protocols to maximize compatibility with existing clients.
|
The Arsse is a news aggregator server which implements [version 1.2](https://github.com/nextcloud/news/blob/master/docs/externalapi/Legacy.md) of [NextCloud News](https://github.com/nextcloud/news)' client-server synchronization protocol. Unlike most other aggregator servers, The Arsse does not include a Web front-end (though one is planned as a separate project), and it relies on existing protocols to maximize compatibility with existing clients.
|
||||||
|
|
||||||
At present the software should be considered in an "alpha" state: though its core subsystems are covered by unit tests and should be free of major bugs, not everything has been rigorously tested. Additionally, though the NextCloud News protocol is fully supported, many features one would expect from other similar software have yet to be implemented. Areas of future work include:
|
At present the software should be considered in an "alpha" state: though its core subsystems are covered by unit tests and should be free of major bugs, not everything has been rigorously tested. Additionally, though the NextCloud News protocol is fully supported, many features one would expect from other similar software have yet to be implemented. Areas of future work include:
|
||||||
|
|
||||||
|
@ -11,7 +11,7 @@ At present the software should be considered in an "alpha" state: though its cor
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
Arsse has the following requirements:
|
The Arsse has the following requirements:
|
||||||
|
|
||||||
- A Web server
|
- A Web server
|
||||||
- PHP 7.0.7 or newer with the following extensions:
|
- PHP 7.0.7 or newer with the following extensions:
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "jkingweb/arsse",
|
"name": "jkingweb/arsse",
|
||||||
"type": "library",
|
"type": "project",
|
||||||
"description": "TODO",
|
"description": "TODO",
|
||||||
"keywords": ["rss"],
|
"keywords": ["rss"],
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
|
|
Loading…
Reference in a new issue