[neomutt-devel] Learning / Reviewing the Code

[Richard Russon]

All changes to the code should go though code review.
That means opening a Pull Request (PR).
    https://github.com/neomutt/neomutt/pulls

This gives other developers a chance to check that the code works ask
questions about the implementation and spot any silly mistakes.

*This is an invitation to everyone* to ask questions in the PRs and learn about the code.

Creating a Pull Request (PR) automatically triggers lots of GitHub Actions.
They perform a suites of tests, including:

- Build NeoMutt with a variety of `configure` options
- Check the Unit Tests succeed
- Check for memory leaks (ASAN)
  https://neomutt.org/dev/analysis/asan
- Fuzz testing on the address parser
- Static "Code Quality" checks
  https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-with-codeql

For more info, see:

- Docs for GitHub Actions
  https://docs.github.com/en/actions
- NeoMutt's Actions (yaml config)
  https://github.com/neomutt/neomutt/tree/main/.github/workflows
- Results of recent Actions
  https://github.com/neomutt/neomutt/actions

Cheers,
    FlatCap / Rich
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <https://mailman.neomutt.org/pipermail/neomutt-devel-neomutt.org/attachments/20230722/b1003945/attachment.sig>