quantum-espresso/CONTRIBUTING.md

2.2 KiB

How to contribute

You can contribute to this project in many ways:

Development

If you want to contribute serious and non-trivial stuff ( or even simple and trivial stuff ) you just have to fork this repository; keep it updated; when your contribution is ready, submit a merge request to the development branch of this repository. After some basic tests ran by gitlab CI and approval your changes will be merged in develop. When the whole test-suite has been tested your contribution will be merged to the master branch.

A basic guide on how to work with git can be found here. A more thorough introduction to git is provided by proGit online e-book

Proposed workflow

Development tools

Here you can find several tools that will assist you while contributing to the QE source code.

Creating Issues

You can report bugs and propose new developments posting on the issue section of this repository. Partecipation to the issue discussions are also a welcome contribution. When reporting bugs try to help other partecipant to reproduce the problem by providing input and output files.