============
Contributing
============

Warewulf is an open source project, and we are grateful for any support or
contributions. Helping other users, raising issues, writing documentation, and
contributing code are all ways to help!

Join the community
==================

Whether you develop Warewulf or use it to deploy clusters, we hope ypu'll spread
the word! Share your experiences online. Ask your distribution to include
support for Warewulf. Consider giving a talk at a conference or meetup!

Warewulf on Slack
-----------------

Many members of the Warewulf community, including its developers, communicate
via Slack. It's a great place to get help with an issue or talk about your
deployment.

An invite link is available at `https://warewulf.org/help/ <https://warewulf.org/help/>`.

OpenHPC
-------

OpenHPC includes Warewulf v4 (and Warewulf 3 before it) as a supported cluster
management system and deployment strategy. Participating in the OpenHPC
community is also a great way to support Warewulf!

Raise an Issue
==============

For general bugs/issues, you can open an issue `at the GitHub repo
<https://github.com/warewulf/warewulf/issues/new>`_.

Contribute to the Code
======================

We use the traditional `GitHub Flow
<https://guides.github.com/introduction/flow>`_ to develop. This means that you
fork the main repo, create a new branch to make changes, and `submit a pull
request (PR) <https://help.github.com/articles/creating-a-pull-request>`_ to the
main branch.

Check out our official `CONTRIBUTING.md
<https://github.com/warewulf/warewulf/blob/main/CONTRIBUTING.md>`_ document.