Skip to content
This repository has been archived by the owner on Oct 9, 2023. It is now read-only.

Latest commit

 

History

History
34 lines (21 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 2.28 KB

Contributing

Table of contents

Introduction

Thank you very much for being here! First of all, I want to let you know that contributions are more than welcome and really appreciated.

In case you want to contribute, even with a small bug fix, you will be featured into the credits file.

How to contribute

To add your contribution, please follow these guidelines:

  1. Fork your own copy of the repository.
  2. Work on your changes / improvements in the forked repo.
  3. Test if your changes / improvements are correctly implemented and all the other features are not compromised. For this latter requirement, please run the main executables and check if you find something different from before.
  4. Optional, but really appreciated: update the main README with the new features you added.
  5. Finally, make the pull request.

Once your pull request will be submitted, I will carefully review it and, if it will be considered as an improvement, I will confirm it.

How to raise an issue

If you find any bug or something you think doesn't work correctly in the code, you are free to open an issue, but before carefully read this passages:

  1. If this issue is due to download, compilation or installation of the software, be sure to have read this document, in which all the passages are explained in detail.
  2. If this issue is due to a code feature, be sure to have run the main executables before, in order to see if your machine has all the necessary prerequisites installed.

Once the issue is received, I will analyze it and once is solved I will respond asking confirmation about my fixing. In this case, if any answer is received in 7 days, the issue will be automatically closed.