.. _contributing:

Contribution
============

Any contribution is more than welcome :heart:.
Just fill an issue_ or a `pull request`_ and we will check ASAP!

Before start contributing
-------------------------

- Make sure you agree to contribute your code under
  `graphomics` license_.

- If you are going to fix a bug, check that it's still exists
  and that you are working with the latest version of
  `graphomics` library.

- Make sure that there is not someone working on the same issue.
  In this case you can provide support or suggestion in the issue.

- If you have any question about the library fill an issue with
  the same criteria described in the previous step.

Pull Request and Contribution
-----------------------------

Please consider the following step to create a pull request which
can be processed as quickly as possible

- Install Git.

- Create your account on Github.

- Fork this_ repository.

- Create your feature branch (under `dev` branch).

- Choose a task for yourself. It could be a bugfix or some new code.

- Add documentation (`docstring`) to your functions/methods if you
  are working on the Python version. Add comments about what you are
  doing in functions/methods.

- Add tests for your contributions.

- Pass **ALL** CI tests.

- Submit a Pull Request into `dev`
  (following the pull request template_).


Merging
-------

- As soon as possible the authors will review your pull request,
  answering to your message.

- Make sure you got credits at the end of merge: we have a lot of project
  to follow and we may forget to add your name to the list of authors.
  Please, do not hesitate to remind us!


.. _issue: https://github.com/Nico-Curti/graphomics/blob/main/.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md
.. _`pull request`: https://github.com/Nico-Curti/graphomics/blob/main/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md
.. _license: https://github.com/Nico-Curti/graphomics/blob/main/LICENSE
.. _this: https://github.com/Nico-Curti/graphomics
.. _template: https://github.com/Nico-Curti/graphomics/blob/main/.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md