Something isn't working right or I have an idea for a functionality. Where can I post that?

[jacob-mannhardt]

I have discovered something in the code that ...:

• ... is missing (a future functionality)
• ... would be cool to have (a nice-to-have)
• ... is not working (a bug)
• ... is something else

Where can I best post that so that everybody keeps that in mind?

[jacob-mannhardt]

An urgent bug that keeps the code from working

We always try to have a working code in the master and development branch! The master and development branch are always tested and only merged if we are confident that it is working as intended. But sometimes there are special cases which we didn't account for, and the code doesn't work anymore as intended. The best steps to take are:

1. First check the issues in https://github.com/RRE-ETH/Energy-Carbon-Optimization-Platform/issues and the discussions in https://github.com/RRE-ETH/Energy-Carbon-Optimization-Platform/discussions. Maybe somebody else has seen and reported that already.
2. If you know what it is, try to fix it yourself. If you did, write an issue and mark it with bug in the Labels tab.
3. If you do not know what it is, write a question in the discussions tab. Maybe somebody else has seen that before and can assist you in fixing the bug.
4. The bug should then be reported in the issues as well to be fixed in the next update.
5. If nobody replies quickly enough, feel free to reach out!

A bug, but the code still works

Sometimes there is an error in how something is calculated in the algorithm, or something is missing, but the code still works. Then write an issue and mark is as bug.

Something else for the future

Our framework is never completely finished, so there are always things to improve. If there is something missing that you think is needed in the future, write an issue and mark it as enhancement. If it is not entirely necessary, but would be a great addition to the framework, mark it as nice-to-have.

Rule of thumb: It's always better to write an issue too many than too few!

Enjoy the optimality
🐛