Commit Graph

44 Commits

Author SHA1 Message Date
Michael Vetter
4be8ec47fe docs: Add section about sanitizers to contributing.md
Signed-off-by: Michael Vetter <jubalh@iodoru.org>
2026-04-03 10:19:40 +02:00
Michael Vetter
a643fd87cc docs: Remove autotools leftover from CONTRIBUTING.md
Signed-off-by: Michael Vetter <jubalh@iodoru.org>
2026-04-03 08:33:59 +02:00
Paul Fertser
5670ccb2b1 chore: support building libstrophe as a subproject
Allow building the latest libstrophe from upstream Git automatically when
-Dforce_fallback_for=libstrophe is passed.

Default to find and link against system-provided libstrophe stays the same.

Signed-off-by: Paul Fertser <fercerpav@gmail.com>
2026-04-02 13:07:04 +03:00
Michael Vetter
bc777c56b2 feat: Remove autotools and adapt docu and scripts
We will only use Meson from now on.

Signed-off-by: Michael Vetter <jubalh@iodoru.org>
2026-03-27 21:33:44 +01:00
Michael Vetter
a8c7850a97 chore: Unify build configuration script into one
Earlier ci/meson-build.sh and ci/ci-build.sh.
The latter we then renamed to the more descriptive build-configuration-matrix.sh.

Both scripts are doing the same thing but for different build systems.
So lets merge them together.

Signed-off-by: Michael Vetter <jubalh@iodoru.org>
2026-03-21 01:05:16 +01:00
Michael Vetter
4347af833a chore: Use more descriptive names for helper scripts
Signed-off-by: Michael Vetter <jubalh@iodoru.org>
2026-03-21 00:18:52 +01:00
Michael Vetter
c7834e022b chore: Require DCO from now on
Explain the how and why in CONTRIBUTING.md

Signed-off-by: Michael Vetter <jubalh@iodoru.org>
2026-03-20 14:16:46 +01:00
Michael Vetter
8548dfca96 ci: Move CI related files into own directory 2026-03-20 08:36:17 +01:00
Michael Vetter
27b5f0fbda build(meson): add support for libomemo-c as OMEMO backend
Add the ability to choose between libsignal-protocol-c (default)
and libomemo-c when building with OMEMO support enabled in Meson.

Close: https://github.com/profanity-im/profanity/pull/2020
2026-03-19 19:01:50 +01:00
Michael Vetter
ab3f58b3a3 docs: Add information about footers in git commit messages 2026-03-09 13:32:05 +01:00
Michael Vetter
562b7c2ab9 docs: Add Conventional Commit Structure 2026-03-09 12:08:26 +01:00
Michael Vetter
285a5086ca docs: Add note about sanitizers overhead 2026-03-06 09:53:49 +01:00
Michael Vetter
f3e3a64ec2 docs: Add a section explaining how to write functional tests 2026-03-06 09:45:51 +01:00
Michael Vetter
cea4c961e0 docs: Add section explaining how to run functional tests 2026-03-06 09:35:58 +01:00
Michael Vetter
aadf912e0e docs: Expand the build section in CONTRIBUTING.md
Usually we point to the website. But honestly it's cumbersome for
developers to update the website. Let's decide later whether we remove
the section there or how we keep it in sync.

But for now let's just add a detailed build section here.
Especially since now we ship autotools *and* meson.

Also mention the convention that we use `build_run` as the meson build
dir. The quality script will depend on this.
2026-02-28 14:52:36 +01:00
Michael Vetter
91911b3e2f ci: Update clang-format to version 21
Update the gh workflow to pin clang-format to version 21.

Mention the version we use in CONTRIBUTING.md.
And hint to the workflow file if we want to change it.
2026-02-28 14:52:36 +01:00
Michael Vetter
109347eea5 docs: Explain how to turn clang-format of for some blocks of code 2026-02-28 14:52:36 +01:00
Michael Vetter
174848499d feat: Add unified quality-check script and git hook support
Move the `make doublecheck` functionality into a build system agnostic
script.

`scripts/quality-check.sh` can now be used to check for spelling via
codespell, formatting clang-format and run the unit tests.

`make doublecheck` and `meson compile doublecheck` will call this
script.

Sometimes we have issues with different versions of clang-format locally
vs our CI. In this case SKIP_FORMAT env variable can be set.
2026-02-28 14:52:27 +01:00
Michael Vetter
b29326969c docs: Explain how to write unit tests 2026-02-28 12:56:13 +01:00
Steffen Jaeckel
f67c76c032 Add make target my-prof.supp
This creates a "as personal as possible" Valgrind suppressions file.

Signed-off-by: Steffen Jaeckel <s@jaeckel.eu>
2025-01-28 16:43:13 +01:00
Michael Vetter
beeddda568 docs: Add more info to ignore revs 2024-06-24 10:24:40 +02:00
Michael Vetter
a8ba8af0de Add link to fugitive 2024-06-20 17:39:04 +02:00
Michael Vetter
7e0338b369 Add hint about git blame ignore to CONTRIBUTING.md 2024-06-20 17:36:54 +02:00
Michael Vetter
951df64a43 docs: Add info about different clang-format versions
Make this clear to new users. Since sjaeckel had reservations
on https://github.com/profanity-im/profanity/pull/1828.
2023-04-15 11:50:57 +02:00
Michael Vetter
54cf152130 contributing: add note about testing 2023-04-09 21:25:28 +02:00
Michael Vetter
a0d5c07a4c Fix headings in contributing.md 2023-03-31 14:14:52 +02:00
Michael Vetter
e1d45f05d3 Update to new mailing list
Maintained by https://github.com/StefanKropp
2023-03-01 15:25:41 +01:00
Michael Vetter
0bae298746 Update mailing list link 2023-01-10 10:24:44 +01:00
Michael Vetter
a0f8adc681 Add commit info to CONTRIBUTING.md 2022-10-10 08:05:11 +02:00
Michael Vetter
5d945a9629 contributing: add part about other git services 2022-09-06 20:01:51 +02:00
Michael Vetter
22064b3a28 contrib: request screenshot upon UI change 2022-05-02 09:59:08 +02:00
Michael Vetter
81b5230da5 Add hint about shortcuts 2022-03-02 17:24:32 +01:00
Michael Vetter
3defa56dcb Add build section to contributing.md 2022-02-23 13:14:58 +01:00
Michael Vetter
d15f905d83 Add unit tests section to CONTIBUTING.md
And rename a header.
2022-02-18 18:49:43 +01:00
Michael Vetter
a9c875e2ce Update the contributing guide
We need to define some rules to make sure people know what they need to
take care about.
To allow us to later still understand the changes in an optimal way and
make everyones work easier.
2022-02-17 14:02:45 +01:00
Michael Vetter
46c8245af9 Format new register code correctly 2021-10-13 21:32:44 +02:00
Michael Vetter
ce5bf721ca Mention make spell and doublecheck in contributing.md 2021-10-05 09:49:50 +02:00
Michael Vetter
02e7cc029c Add codespell info to contributing 2021-10-01 23:16:17 +02:00
Michael Vetter
e3797076d9 Add filetype check to pre hook example
We have `Language: Cpp` in .clang-format but recently it tried to format
my makefile anyways.
Let's add this to be sure.
2020-07-15 11:36:39 +02:00
William Wennerström
815a655768 Add highlighting 2020-07-07 10:11:31 +02:00
William Wennerström
d1bf922b1a Tip about pre-push hook in contribution guidelines 2020-07-07 10:06:47 +02:00
Michael Vetter
1bbb819dac Add pre-commit hook clang-format example
Regards https://github.com/profanity-im/profanity/issues/1396
2020-07-07 09:51:47 +02:00
Michael Vetter
66f9a6b721 Add clang-format file
People should run `make format` before doing a commit.
Fix https://github.com/profanity-im/profanity/issues/1396
2020-07-07 09:42:00 +02:00
Michael Vetter
2592216084 Add CONTRIBUTING.md 2019-07-23 09:25:17 +02:00