Maintenance

This section contains the documentation for Hexatomic maintenance work.

The maintainer is the central position in the Hexatomic software project. They are responsible for completing the following tasks. All tasks should be completed in a timely fashion, and based on the Hexatomic code of conduct.

Maintenance work

  • Ensure that Hexatomic always builds without errors in the master and develop branches
  • Fix security issues and bugs
  • Maintain templates, configuration files, community files (README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, etc.), licenses, etc.

Contributions

  • Ensure that citation information is always up-to-date (in CITATION.cff)
  • Ensure that the contributors list is always up-to-date (in README.md, maintained via the All Contributors bot)
  • Maintain pull requests

Code review

  • Perform code reviews
  • Document & triage unreviewed code

Issues

  • Communicate with issue authors: answer questions, and suggest fixes, or make fixes themself if possible or necessary
  • Do issue housekeeping: check open issues regularly, and fix and/or close where possible

Releases

  • Release Hexatomic
  • Publish new releases

Documentation

  • Maintain user documentation and ensure that it is up-to-date with each contribution
  • Maintain developer and maintainer documentation and ensure that it is up-to-date with each contribution
  • Document the current state of practice for developing and maintaining Hexatomic

Communication & community work

  • Publicize releases to the relevant stakeholders
    • Includes emails to the user mailing list hexatomic-users@lists.hu-berlin.de
  • Redirect questions to the issue tracker
  • Update external resources
  • Work with and build the community of users and developers

Prepare maintainer changes

  • Prepare the repositories for takeover by a new maintainer
  • Document takeover by a new maintainer