Hello there!
The LINBIT team welcomes and appreciates community contributions to LINSTOR that improve the quality of the software.
Use the following guidelines when contributing to the LINSTOR code repository.
Opening issues
When opening an issue, clearly state the problem you are running into.
The more detail you can provide the better.
An issue must contain at least the following information:
- Version of LINSTOR
- The controller:
linstor controller version
- The client:
linstor --version
- Clear description of the error:
- Either provide the exact error message, or the LINSTOR ErrorReport(s) if any exist.
- If neither exist, clearly describe what happened and what you expected to happen.
- If possible, include steps to reproduce the issue.
- A reproducer is in most cases the most important part of an issue. It helps code maintainers to find, understand, and eventually properly fix the root cause of the issue.
Creating pull requests and limiting AI use
When creating a pull request, limit your use of AI.
Unless you are very familiar with LINSTOR and its internal components and procedures, limit AI use to generating reproducers for the issue you want to get fixed, rather than generating code.
In many cases where AI generates a "fix" to a problem it only fixes the symptom.
Even if the error apparently no longer occurs after applying the "fix", the root cause might still exist and the "fix" could affect other parts of the code in unwanted or unforeseen ways.
Creating an issue reproducer can sometimes be difficult when involving issues such as race-conditions that might not reproduce easily.
However a reproducer with a description such as, "If between steps X and Y this race-condition happens, the bug triggers with the effect of ..." is more helpful for the LINBIT team than attempting a code fix by using AI, due to the reasons stated above.
Thanks in advance!
Hello there!
The LINBIT team welcomes and appreciates community contributions to LINSTOR that improve the quality of the software.
Use the following guidelines when contributing to the LINSTOR code repository.
Opening issues
When opening an issue, clearly state the problem you are running into.
The more detail you can provide the better.
An issue must contain at least the following information:
linstor controller versionlinstor --versionCreating pull requests and limiting AI use
When creating a pull request, limit your use of AI.
Unless you are very familiar with LINSTOR and its internal components and procedures, limit AI use to generating reproducers for the issue you want to get fixed, rather than generating code.
In many cases where AI generates a "fix" to a problem it only fixes the symptom.
Even if the error apparently no longer occurs after applying the "fix", the root cause might still exist and the "fix" could affect other parts of the code in unwanted or unforeseen ways.
Creating an issue reproducer can sometimes be difficult when involving issues such as race-conditions that might not reproduce easily.
However a reproducer with a description such as, "If between steps X and Y this race-condition happens, the bug triggers with the effect of ..." is more helpful for the LINBIT team than attempting a code fix by using AI, due to the reasons stated above.
Thanks in advance!