From b4d3563b9604ad85725622d34428b607a60f87e3 Mon Sep 17 00:00:00 2001 From: Jabber Developer Date: Fri, 20 Jun 2025 18:20:47 +0000 Subject: [PATCH] Cleanup (#5) - Update formatting for stub files - Update docs While original project, Profanity, provides valuable basis for this fork, we are not affiliated with the upstream. This commit is updating documentation to reflect accurate information. The docs are going to be updated further once the website is created. Reviewed-on: https://git.jabber.space/devs/profanity/pulls/5 Co-authored-by: Jabber Developer Co-committed-by: Jabber Developer --- .github/FUNDING.yml | 12 ------- .github/ISSUE_TEMPLATE | 2 -- .github/pull_request_template.md | 4 +-- CONTRIBUTING.md | 4 +-- README.md | 37 ++++---------------- RELEASE_GUIDE.md | 2 +- SPONSORS.md | 22 ------------ tests/unittests/omemo/stub_omemo.c | 2 +- tests/unittests/tools/stub_aesgcm_download.c | 4 +-- tests/unittests/tools/stub_http_download.c | 4 +-- tests/unittests/tools/stub_http_upload.c | 4 +-- tests/unittests/ui/stub_ui.c | 8 ++--- tests/unittests/xmpp/stub_avatar.c | 2 +- tests/unittests/xmpp/stub_xmpp.c | 4 +-- 14 files changed, 25 insertions(+), 86 deletions(-) delete mode 100644 .github/FUNDING.yml delete mode 100644 SPONSORS.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml deleted file mode 100644 index 017a6e97..00000000 --- a/.github/FUNDING.yml +++ /dev/null @@ -1,12 +0,0 @@ -# These are supported funding model platforms - -github: jubalh -patreon: # Replace with Patreon username -open_collective: # Replace with a single Open Collective username -ko_fi: # Replace with a single Ko-fi username -tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel -community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry -liberapay: # Replace with a single Liberapay username -issuehunt: # Replace with a single IssueHunt username -otechie: # Replace with a single Otechie username -custom: # Replace with a single custom sponsorship URL diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE index a95dfa66..08f60b0e 100644 --- a/.github/ISSUE_TEMPLATE +++ b/.github/ISSUE_TEMPLATE @@ -20,8 +20,6 @@ 1. 2. -3. -4. ## Context diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 26c901b2..cd6266ae 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,5 +5,5 @@ - [ ] I ran valgrind when using my new feature ### How to test the functionality -* step 1 -* step 2 +- step 1 +- step 2 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 55f70a90..b37e02d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,8 +10,8 @@ We recommend for people to always work on a dedicated git branch for each fix or Don't work on master. So that they can easily pull master and rebase their work if needed. -For fixing (reported) bugs we usually use `git checkout -b fix/issuenumber-somedescription`. -When working on a new feature we usually use `git checkout -b feature/optionalissuenumber-somedescription`. +For fixing (reported) bugs we usually use `git switch -c fix/issuenumber-somedescription`. +When working on a new feature we usually use `git switch -c feature/optionalissuenumber-somedescription`. However this is not a rule just a recommendation to keep an overview of things. If your change isn't a bugfix or new feature you can also just use any branch name. diff --git a/README.md b/README.md index 38cf3a71..bac5a2b7 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,6 @@ Profanity is a console based XMPP client inspired by [Irssi](http://www.irssi.org/). -If you like Profanity consider becoming a sponsor or [donate](https://profanity-im.github.io/donate.html) some money. - ![alt tag](https://profanity-im.github.io/images/prof-2.png) See the [User Guide](https://profanity-im.github.io/userguide.html) for information on installing and using Profanity. @@ -12,26 +10,10 @@ See the [User Guide](https://profanity-im.github.io/userguide.html) for informat ## Project This project is about freedom, privacy and choice. We want to enable people to chat with one another in a safe way. Thus supporting encryption (OTR, PGP, OMEMO, OX) and being decentralized, meaning everyone can run their own server. We believe [XMPP](https://xmpp.org/) is a great proven protocol with an excellent community serving this purpose well. -Feel free to follow us on [twitter](https://twitter.com/profanityim), join our [mailing list](https://lists.posteo.de/listinfo/profanity) and/or [MUC](xmpp:profanity@rooms.dismail.de?join). ## Installation Our [user guide](https://profanity-im.github.io/userguide.html) contains an [install](https://profanity-im.github.io/guide/latest/install.html) section and a section for [building](https://profanity-im.github.io/guide/latest/build.html) from source yourself. -## Donations -We would highly appreciate it if you support us via [GitHub Sponsors](https://github.com/sponsors/jubalh/). Especially if you make feature requests or need help using Profanity. -Sponsoring enables us to spend time on Profanity. - -An alternative way to support us would be to ask for our IBAN or use Bitcoin: `bc1qx265eat7hfasqkqmk9qf38delydnrnuvzhzy0x`. - -Issues backed by a sponsor will be tagged with the [sponsored](https://github.com/profanity-im/profanity/issues?q=label%3Asponsored+) label. -Feature requests that we consider out of scope, either because of interest or because of time needed to implement them, will be marked with the [unfunded](https://github.com/profanity-im/profanity/issues?q=label%3Aunfunded) label. - -Another way to sponsor us or get an issue solved is to comment on an issue that you are willing to sponsor it. - -Tasks from our [sponsors](SPONSORS.md) will be tackled first. - -Thank you! <3 - ## How to contribute We tried to sum things up on our [helpout](https://profanity-im.github.io/helpout.html) page. Additionally you can check out our [blog](https://profanity-im.github.io/blog/) where we have articles like: @@ -40,26 +22,19 @@ For more technical details check out our [CONTRIBUTING.md](CONTRIBUTING.md) file ## Getting help To get help, first read our [User Guide](https://profanity-im.github.io/userguide.html) then check out the [FAQ](https://profanity-im.github.io/faq.html). -If you have are having a problem then first search the [issue tracker](https://github.com/profanity-im/profanity/issues). +If you are having a problem then first search the [issue tracker](https://github.com/profanity-im/profanity/issues). If you don't find anything there either come to our [MUC](xmpp:profanity@rooms.dismail.de?join) or create a new issue depending on what your problem is. ## Links ### Website -URL: https://profanity-im.github.io + -Repo: https://github.com/profanity-im/profanity-im.github.io +Repo: https://git.jabber.space/devs/profanity -### Blog -URL: https://profanity-im.github.io/blog - -Repo: https://github.com/profanity-im/blog - -### Mailinglist -Mailing List: https://lists.posteo.de/listinfo/profanity - -### Chatroom -MUC: profanity@rooms.dismail.de + ### Plugins Plugins repository: https://github.com/profanity-im/profanity-plugins diff --git a/RELEASE_GUIDE.md b/RELEASE_GUIDE.md index 1a1f18bf..8e7cf2b8 100644 --- a/RELEASE_GUIDE.md +++ b/RELEASE_GUIDE.md @@ -13,7 +13,7 @@ * Generate HTML docs (the docgen argument only works when package status is development) `./profanity docgen` -* Determine if libprofanitys version needs to be [increased](https://github.com/profanity-im/profanity/issues/973) +* Determine if `libprofanity`'s version needs to be [increased](https://github.com/profanity-im/profanity/issues/973) * Update plugin API docs (./apidocs/c and ./apidocs/python) need to run the `gen.sh` and commit the results to the website git repo * Update CHANGELOG * Update profrc.example diff --git a/SPONSORS.md b/SPONSORS.md deleted file mode 100644 index 33182d23..00000000 --- a/SPONSORS.md +++ /dev/null @@ -1,22 +0,0 @@ -# Giving back - -Thank you very much to all of our sponsors and donors (including those that want to stay private)! - -## Sponsors -[Martin Dosch](https://github.com/mdosch) since January 2020 - -[Alexander Dahl](https://github.com/LeSpocky) since January 2021 - -[James Pond](https://github.com/jamesponddotco) since February 2021 - -## Donors -[Martin Dosch](https://github.com/mdosch) - -[Julian Huhn](https://github.com/huhndev) - -[Matteo Bini](https://github.com/matteobin) - -## Services -[Stefan Kropp](https://github.com/StefanKropp) for sponsoring our [mailing list](https://lists.posteo.de/listinfo/profanity) - -[dismail](https://dismail.de/) for hosting our [MUC](xmpp:profanity@rooms.dismail.de?join) diff --git a/tests/unittests/omemo/stub_omemo.c b/tests/unittests/omemo/stub_omemo.c index 986de079..095fd81c 100644 --- a/tests/unittests/omemo/stub_omemo.c +++ b/tests/unittests/omemo/stub_omemo.c @@ -109,7 +109,7 @@ omemo_encrypt_file(FILE* in, FILE* out, off_t file_size, int* gcry_res) { return NULL; }; -void omemo_free(void* a){}; +void omemo_free(void* a) {}; uint32_t omemo_device_id() diff --git a/tests/unittests/tools/stub_aesgcm_download.c b/tests/unittests/tools/stub_aesgcm_download.c index 07f411ca..62c41de8 100644 --- a/tests/unittests/tools/stub_aesgcm_download.c +++ b/tests/unittests/tools/stub_aesgcm_download.c @@ -22,7 +22,7 @@ aesgcm_file_get(void* userdata) return NULL; }; -void aesgcm_download_cancel_processes(ProfWin* window){}; -void aesgcm_download_add_download(AESGCMDownload* download){}; +void aesgcm_download_cancel_processes(ProfWin* window) {}; +void aesgcm_download_add_download(AESGCMDownload* download) {}; #endif diff --git a/tests/unittests/tools/stub_http_download.c b/tests/unittests/tools/stub_http_download.c index aff47200..8acecdff 100644 --- a/tests/unittests/tools/stub_http_download.c +++ b/tests/unittests/tools/stub_http_download.c @@ -27,7 +27,7 @@ http_file_get(void* userdata) return NULL; } -void http_download_cancel_processes(){}; -void http_download_add_download(){}; +void http_download_cancel_processes() {}; +void http_download_add_download() {}; #endif diff --git a/tests/unittests/tools/stub_http_upload.c b/tests/unittests/tools/stub_http_upload.c index 49320f85..d1d0e59c 100644 --- a/tests/unittests/tools/stub_http_upload.c +++ b/tests/unittests/tools/stub_http_upload.c @@ -38,7 +38,7 @@ file_size(int filedes) return 0; } -void http_upload_cancel_processes(){}; -void http_upload_add_upload(){}; +void http_upload_cancel_processes() {}; +void http_upload_add_upload() {}; #endif diff --git a/tests/unittests/ui/stub_ui.c b/tests/unittests/ui/stub_ui.c index 6ee0ed25..3dead0db 100644 --- a/tests/unittests/ui/stub_ui.c +++ b/tests/unittests/ui/stub_ui.c @@ -484,10 +484,10 @@ mucwin_unset_message_char(ProfMucWin* mucwin) { } -void win_update_entry_message(ProfWin* window, const char* const id, const char* const message){}; -void win_mark_received(ProfWin* window, const char* const id){}; -void win_print_http_transfer(ProfWin* window, const char* const message, char* id){}; -void win_print_loading_history(ProfWin* window){}; +void win_update_entry_message(ProfWin* window, const char* const id, const char* const message) {}; +void win_mark_received(ProfWin* window, const char* const id) {}; +void win_print_http_transfer(ProfWin* window, const char* const message, char* id) {}; +void win_print_loading_history(ProfWin* window) {}; void ui_show_roster(void) diff --git a/tests/unittests/xmpp/stub_avatar.c b/tests/unittests/xmpp/stub_avatar.c index 8390077e..022664ac 100644 --- a/tests/unittests/xmpp/stub_avatar.c +++ b/tests/unittests/xmpp/stub_avatar.c @@ -2,7 +2,7 @@ #include #include -void avatar_pep_subscribe(void){}; +void avatar_pep_subscribe(void) {}; gboolean avatar_get_by_nick(const char* nick, gboolean open) diff --git a/tests/unittests/xmpp/stub_xmpp.c b/tests/unittests/xmpp/stub_xmpp.c index 366f26b3..5af8c5c2 100644 --- a/tests/unittests/xmpp/stub_xmpp.c +++ b/tests/unittests/xmpp/stub_xmpp.c @@ -312,8 +312,8 @@ presence_sub_request_exists(const char* const bare_jid) } // iq functions -void iq_disable_carbons(){}; -void iq_enable_carbons(){}; +void iq_disable_carbons() {}; +void iq_enable_carbons() {}; void iq_send_software_version(const char* const fulljid) {