qxmpp
qxmpp copied to clipboard
Add DOAP file, remove XEP list file and adapt PR template
PR check list:
- [x] Document your code
- [x] Add
\since QXmpp 1.X
- [x] Fix doxygen warnings (see log when building with
-DBUILD_DOCUMENTATION=ON
) - [x] Update
doc/xep.doc
- [x] Add unit tests
- [x] Format the code: Run
clang-format -i src/<edited-file(s)> tests/<edited-file(s)>
Codecov Report
Merging #438 (f485629) into master (860640c) will not change coverage. The diff coverage is
n/a
.
:exclamation: Current head f485629 differs from pull request most recent head 6838747. Consider uploading reports for the commit 6838747 to get more accurate results
@@ Coverage Diff @@
## master #438 +/- ##
=======================================
Coverage 68.56% 68.56%
=======================================
Files 267 267
Lines 23607 23607
=======================================
Hits 16187 16187
Misses 7420 7420
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.
@lnjX The DOAP file can be used to create a human-readable page. QXmpp's Doxygen page could link to it. We are working on such a page located on https://xmpp.org/software/libraries/.
It's nice that it's possible to generate such a page. What I'm still missing to continue here is a non-external replacement for xep.doc that is generated from the DOAP file.
@lnjX The XEP list is now integrated in the Doxygen documentation.
I ran
make doc
and opened the file locally with firefox and I got this.
$ reuse lint
# MISSING COPYRIGHT AND LICENSING INFORMATION
The following files have no copyright and licensing information:
* ../SECURITY.md
* ../doc/doap-iframe.html
* ../doc/doap.css
* ../doc/doap.xsl
* ../doc/xeplist.xml
* ../src/omemo/README.md
# SUMMARY
* Bad licenses:
* Deprecated licenses:
* Licenses without file extension:
* Missing licenses:
* Unused licenses:
* Used licenses: CC0-1.0, LGPL-2.1-or-later, LicenseRef-MIT-variant
* Read errors: 0
* Files with copyright information: 399 / 413
* Files with license information: 399 / 413
Unfortunately, your project is not compliant with version 3.0 of the REUSE Specification :-(
please fix the missing license information in doc/
I just added a reuse
github action.
I ran
make doc
and opened the file locally with firefox and I got this.
You have to run a local server for that purpose because Firefox prohibits the request to doap.xsl
.
Try the following:
cd build/doc/html/
python3 -m http.server
firefox http://0.0.0.0:8000/xep.html
please fix the missing license information in
doc/
I created https://github.com/pulkomandy/xmpp-doap/issues/16 for that because the project itself does not provide any license information.
@lnjX I added missing information to the DOAP file and rebased everything.
@lnjX How can we temporarily update xeplist.xml
in order to be used by https://doc.qxmpp.org/qxmpp-dev/?
@lnjX How can we temporarily update xeplist.xml in order to be used by https://doc.qxmpp.org/qxmpp-dev/?
You mean only updating it in the generated version, but not in the main qxmpp repository?
We can add it to the CI job.
@lnjX How can we temporarily update xeplist.xml in order to be used by https://doc.qxmpp.org/qxmpp-dev/?
You mean only updating it in the generated version, but not in the main qxmpp repository?
We can add it to the CI job.
Yes. That would be useful :)