CONTRIBUTING.md

Contribution guidelines for DuMu^x

DuMu^x and DUNE are community projects and we are happy about all forms of external contributions. Here are many easy things that you can do, like

• read the documentation and tell us where and how it should be improved,
• try to install DuMu^x on your platform and report bugs if it doesn’t work,
• fix bugs and open merge requests or send us patches.

If you decide to contribute code please read this contribution guide.

Style guide

When contributing code to DuMu^x please follow the style guide. Your work will enjoy much smoother sailing if you stick to it with your changes. DuMu^x is a pretty large project, and a consistent way of doing things really helps a lot when trying to find your way around the code.

Contributing

You should get your changes to us in the following way:

• Get an account for our GitLab instance (you might need to contact us if you can't create projects at first login).
• Fork the core module that you want to contribute to, just as you would do on GitHub.
• Push your changes to your fork on some branch.
• Open a merge request using the branch you pushed your changes to as the source branch and the master of the DuMu^x repository as the target branch. GitLab will usually ask you about opening a merge request if you browse it right after pushing to some branch.
• Follow the discussion on the merge request to see what improvements should be done to the branch before merging.
• If you have developer status you don't need to do a fork and you can create branches directly.

If you have any questions or complaints about this workflow of contributing to DuMu^x, please ask on the DuMu^x mailing list.