We are very open to ideas, suggestions and patches to improve this software - it is open source after all!

If you have any wishes or suggestions to improve the software (new ideas, better menus) you can create an issue report

To be able to handle an issue report in the best way, the report itself should be as detailed as possible including:

• What is not working.
• How to reproduce it.
• If possible make sample files to reproduce the issue available.

If you are a developer and found/fixed a bug there is the possibility to create a pull request to get it included into InaSAFE.

Bearing that all in mind you have to create an issue report to make the Developers aware of you improvements.

At first please use the search function to search through the already existing issues. There is a possibility that someone else already found your issue and reported it or already had the same suggestion as you.

You have to think about is where the issue you would like to report is taking place:

There are three possibilities:

1. The InaSAFE software itself: report an issue on the project
2. The Documentation of InaSAFE (would mainly mean the Webpage): report an issue in documentation
3. Found some problems in the infrastructure: report an issue in infrastructure

You can find the green button called New Issue on the top right corner of the screen. Click on it and you will be sent to a new Page.

In the line with "Title" try to enter a self speaking description of your problem/suggestion. Try only to use a few words there.

In the TAB Write you can enter the long description of what you want to tell. Following the guidelines it is recommended to separate your issue into the parts of

1. Problem/Suggestion
2. Proposed Solution
3. Expected outcome

To make your issue report even better readable it is also recommended to use the MD markup language in this report (nothing to be scared of, it is easy to learn and you only need a few basic terms).

The basic construct of a "perfect" issue report will look like this

# Problem/Suggestion
Please add the feature xyz to the project

# Proposed Solution
The feature would work like this: ....
And it would be similar like feature requested in #689 which is documented
in AIFDR/inasafe-doc#46

# Expected outcome
People working with this feature would have the following benefits of it:
As already done in commit @ae56eb which is documented in
AIFDR/inasafe-doc@4a78fe i reference here

Hints for writing a good issue report: (most examples are covered in the example)

• use the buttons available under Add Labels on the right side of your issue report.
• link already existing and related issues to yours by adding a issue number like #608
• link commits already done by entering commit @SHA like @ae67fa

An important thing you can do while reporting an issue is the Add Labels section on the right side of the newly created issue. It is a good idea to mark your issue with the correct Label so that it is clearly visible to developers in which section this issue report belongs to.

Always bear in mind that just because you currently need this feature very urgent does not necessarily mean that it deserves the Label * Highest Priority or * Release Blocker.

Search through all the labels and click the one you want to assign to your report. For example if you request a new feature and you describe your requested feature in the issue report, it is very likely that you want to mark it as * Request for Comments to be commented and probably extended by others as well before being implemented as a well prepared feature.

All labels start with a capital letter. Acronyms are all capitals. Colors are assigned using the following rules:

0. Gray is for issue sizes
1. Reds are used for issues severity
2. Orange is used for issues that need attention from the Documentation and Translation team.
3. Yellows are used for issues that need external input
4. Greens are used for issues handled in the current sprint
5. Petrol is used for Features requests
6. Blue is used for tagging the area of the problem (Optimization, System Architecture, Postprocessing, ...)
7. Navy is not used yet
8. Purple is used for Governance and Rollout

When the same hue is used with more saturations, as a rule of thumb, the darker saturations mean more important.