Development

Step in - here may be more than just consuming

What’s going on?

If you are interested in contributing, please have a look at our Newbie Tutorial.

Any development on features is done in “devel/” feature branches in the NeoMutt repository. Once development is complete, the work will be merged into the main branch.

Finally, some automatic checking is done on commits and pull requests for NeoMutt. It benefits from two free services (free for Open Source). They are triggered on every commit to GitHub.

• GitHub Actions automatically build projects on every commit (Continuous Integration).

• Coverity performs static analysis on the code looking for potential problems.

StarCharts

Development docs

Title	Description
Actions	GitHub Actions
Analysis	Ways to Analyze NeoMutt’s code
Bug-Fix Week	A Period of Stabilisation
Build	Building NeoMutt
Code Style	The preferred style for code committed to NeoMutt
Config System	How Config Variables are handled
Deployment using Actions	Update the website when certain builds succeed
Docs Rebuild	(Re-)Building the Documentation
Documentation	Description of NeoMutt’s documentation process
Doxygen Comments	Formatted Comment Blocks
Easy Tasks	A Great Way to get started in Open Source
GitHub	How the Project uses GitHub
Glossary	A collection of abbreviations/acronyms
Newbie Tutorial	Things every Newbie Should Know
Obsolescence	A list of old projects that can be forgotten
Roadmap	The Future of NeoMutt
Signing Code / Releases	Be Sure You’re Getting the Real Thing
Support	List of supported architectures / operating systems
Translating Strings	How to Translate Strings

• Actions
  • Description
  • Common Behaviour
• Analysis
• Bug-Fix Week
• Build
• Code Style
  • Overview
  • Rules
  • Guidelines
  • Top tips
  • EditorConfig
  • Clang-Format
  • Code Style
• Config System
  • ConfigSet
  • Walkthrough of a Config Item
  • Config Scope
  • Global Config
• Deployment using Actions
  • tl;dr
  • Create Identity
  • Give Permissions to Identity
  • Set up Travis
  • Create Scripts
  • Result
• Docs Rebuild
  • The problem
  • Document format
  • Generating manual.xml
  • Rendering manual.xml
  • Generating the website
  • The future
  • Conclusion
• Documentation
  • Required tools
• Doxygen Comments
  • Functions
• Easy Tasks
  • Start Coding on NeoMutt (with help)
  • How Do I Get Started?
  • What Happens Next?
  • What Else do I Need to Know?
  • Medium Tasks
• GitHub
• Glossary
  • Contributing
  • .ics, .ifb, .iCal, .iFBf
  • ANSI
  • API
  • ASCII
  • BCC
  • BOM
  • CC
  • CMS
  • COPR
  • CR
  • CSS
  • DBCS
  • DNS
  • DSN
  • EOF
  • EOL
  • EOT
  • FOSS
  • GCC
  • GDBM
  • GFM
  • GNU
  • GPGME
  • GSSAPI
  • HTML
  • IDN
  • IMAP, IMAP4
  • IRC
  • LDAP
  • LF
  • LMDB
  • Lua
  • MBCS
  • MIME
  • MUA
  • NCR
  • Notmuch
  • nroff
  • OBDB
  • PGP
  • POP, POP3
  • PPA
  • QDBM
  • RFC
  • RTF
  • SASL
  • SBCS
  • settext
  • SMTP
  • SOCKS
  • SSL
  • Tar
  • tarball
  • TBD
  • TLS
  • UCS
  • URL, URLs
  • UTF
  • UTF-16
  • UTF-32
  • UTF-8
  • YAML
  • ZIP
• Newbie Tutorial
  • TOC
  • Contact
  • GitHub
  • Invitation
  • What you can do in NeoMutt
• Obsolescence
  • Searching
  • Making releases
• Roadmap
• Signing Code / Releases
  • Keys
  • Git example
  • Source example
• Support
  • Motivation
  • Architectures
  • Operating Systems
• How to Translate Strings
  • How does it work?
  • State of the translations
  • Is the job technical?
  • More information
  • Sharing your work
  • Translate-fu

Blue sky

NeoMutt also has a couple of speculative ideas:

• Redesigning Mutt’s architecture

• Redesigning Mutt’s gui

Note: These are just toys (for now).