Contributing overview

Welcome

Want to contribute? You are in the right place.

This page gives a quick overview and points you to the right documents. You can start small. Nothing here requires expert knowledge.

How the project works

Xymon is a community project. Everyone is welcome.

All kinds of help are appreciated, from small fixes to larger contributions. No prior permission is required.

Technical discussions and decisions happen on xymon@xymon.com.

GitHub is used for hosting and tracking, but the mailing list remains the main place for discussion and support.

Working with GitHub

1. Make changes on your computer
2. Push them to your own GitHub fork
3. Open a Pull Request to the main project

That’s it.

How changes move

            +---------------------------------+
            |  UPSTREAM (main project)        |
            |  xymon-monitoring/xymon         |
            +---------------------------------+
                         ^
                         |  Pull Request
                         |
            +---------------------------------+
            |  YOUR FORK                      |
            |  <your-github-username>/xymon   |
            +---------------------------------+
                         ^
                         |
            +---------------------------------+
            |  YOUR COMPUTER                  |
            +---------------------------------+

Where to start

New here?

• Start with first-contribution.md

Need Git help?

• git-installation.md
• git-setup.md

More details

How to contribute:

• git-contribution-flow.md

Rules and good practices:

• git-rules.md
• git-guidelines.md

Working on CI?

• git-actions-upstream-workflow.md
• git-actions-personal-workflow.md

Documentation format

When editing documentation, please follow:

• documentation-format.md