📝 How to submit Issues, Pull Requests and Test Results

[Rikj000]

GitHub Etiquette

• Issues: Meant for Bug Reports but also used as the Planned section for this project. If you don't think you can contribute back a bug-fix, then open a new issue if it hasn't been reported yet.
• Pull Requests: If you think you can make some patch to fix the issue, fork the repo, and make a pull request (once you have pushed your patch back to your fork). When you'd like to send in a new feature/idea it's best to first discuss it with me on the Discord Server or through a PM there to avoid a rejected PR.
• If you make a pull issue first, and then create a pull request, nothing stops you to reference the issue URL in your pull request comment, in order to avoid writing again the context of your patch.

Pull Requests

More PRs are very welcome, but if you send them in, please do 2 to 4 HyperOpts with a full 1000 epochs using the same random state:

• One with the base code (Or 2 for a full process)
• One with your alterations/changes (Or 2 for a full process)
  And then add the full HyperOpt results log output (Including the loading section, HyperOpt Results table and HyperOpt results) for each test you did + Freqtrade version you used + Some Dry Run results 🙂

If you do it like that I will feel comfortable enough to merge it without having to spend hours HyperOpting to confirm if it works on my side, which will make us able to progress way faster! 🚀

Test for improvements

The process is rather simple really on 1st HyperOpt Runs:

• Copy/paste the Run 1 command
• Check/Save the HyperOpt Run 1a Results
• Reset MoniGoMani
• Adjust a single:
  • Setting in mgm-config.json
  • Indicator/weighted signal
  • The spaces used
  • The protections enabled/disabled
  • ...
• Copy/paste the Run 1 command again, use the same --random-state as you used in the previous test
• Compare if the HyperOpt Run 1b Results are better then on your Run 1a attempt

See the How to test for improvements section on the MoniGoMani - Read the Docs website for more information!