Skip to content

JerichoJones/Old-STAK-Support-Guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 

Repository files navigation

How to Submit an Issue Like A Boss!


How-TO and tuning your hardware is not within the scope of Github support and will most likely be ignored. It is just not possible for us to know how to tune every model/version of a component.

How-TO and tuning type questions are better suited to forums such as REDDIT/r/moneromining. There is a much larger audience of people that have probably already been through and resolved the same issue.

Make sure you have reviewed the documentation on the Github as well as running:

	xmr-stak --help

^^ This will answer most How-TO type questions. ^^


Content Overview

Use Markdown (formatting) for logs or code that you post in an Issue ticket.

You will look like a genius and make the text you paste in actually readable! Win! Win! 👍
Below is a simple example of what a code box looks like for your logs/code:

if (isAwesome){  
    return true  
}  

A great tool for creating Markdown documents is StackEdit. I used it to edit this guide. I highly recommend it. - JJ

Create the formatted document for your issue in StackEdit and paste it into your Issue in github.

What you should be doing to make this go as smoothly as possible

  1. Choose a simple, clear title for your Issue Subject

  2. Stick to one problem per issue report.

  3. Describe the issue clearly.

    a. A short synopsis of what is happening.

    b. What you expect should be happening.

    c. Exact error message(s), if any.

    d. Include screenshots and/or logs of the issue.

    e. If useful, edit the screenshot with circles or arrows to highlight the error.

  4. Describe what steps you have performed in an attempt to resolve the issue.

  5. Complete the applicable template section(s) below:

Please provide as much as possible information to reproduce the issue. Use the section that applies to your issue.

  1. If you resolved your issue please note what you did in the Issue ticket so others may benefit from your success!
  2. If you resolved your issue please close it. It would really help us out!

Please don't be that guy and jump into an Issue with your issue unless it is exactly the same. It just confuses the whole situation.

At best, you will be ignored. At worst, you will be mercilessly mocked.


Issue with the execution of STAK

  • Which OS do you use?

  • Type of the CPU. Running stock clocks/voltages? If not, provide settings.

  • Type of the GPU (if you try to miner with the GPU). Running stock clocks/voltages? If not, provide settings.

  • Amount of RAM memory. Running stock clocks/voltages? If not, provide settings.

  • Did you compile the miner yourself or are you running the release?

  • Run

    xmr-stak --version-long

and add the output here

  1. Describe the issue clearly:

    a. A short synopsis of what is happening.

    b. What you expect should be happening.

    c. Exact error message(s), if any.

    d. Include screenshots and/or logs of the issue.

    e. If useful, edit the screenshot with circles or arrows to highlight the error.

  2. Describe what steps you have performed in an attempt to resolve the issue.


Stability issue with STAK

  • Which OS do you use?

  • Type of the CPU. Running stock clocks/voltages? If not, provide settings.

  • Type of the GPU (if you try to miner with the GPU). Running stock clocks/voltages? If not, provide settings.

  • Amount of RAM memory. Running stock clocks/voltages? If not, provide settings.

  1. Describe the issue clearly:

    a. A short synopsis of what is happening.

    b. What you expect should be happening.

    c. Exact error message(s), if any.

    d. Include screenshots and/or logs of the issue.

    e. If useful, edit the screenshot with circles or arrows to highlight the error.

  2. Describe what steps you have performed in an attempt to resolve the issue.


AMD OpenCL issue with STAK

  • Which OS do you use?

    Run `clinfo` and add the output here
    
  1. Describe the issue clearly:

    a. A short synopsis of what is happening.

    b. What you expect should be happening.

    c. Exact error message(s), if any.

    d. Include screenshots and/or logs of the issue.

    e. If useful, edit the screenshot with circles or arrows to highlight the error.

  2. Describe what steps you have performed in an attempt to resolve the issue.


Issue Compiling STAK

  • Which OS do you use?

  • What software are you using to compile? Include versions (this can be very important).

  • Add all commands you used and the full compile output here

  • Run cmake -LA . in the build folder and add the output here

  1. Describe the issue clearly:

    a. A short synopsis of what is happening.

    b. What you expect should be happening.

    c. Exact error message(s), if any.

    d. Include screenshots and/or logs of the issue.

    e. If useful, edit the screenshot with circles or arrows to highlight the error.

  2. Describe what steps you have performed in an attempt to resolve the issue.


Other Issue with STAK

  • Which OS do you use?

  • Type of the CPU. Running stock clocks/voltages? If not, provide settings.

  • Type of the GPU (if you try to miner with the GPU). Running stock clocks/voltages? If not, provide settings.

  • Amount of RAM memory. Running stock clocks/voltages? If not, provide settings.

  1. Describe the issue clearly:

    a. A short synopsis of what is happening.

    b. What you expect should be happening.

    c. Exact error message(s), if any.

    d. Include screenshots and/or logs of the issue.

    e. If useful, edit the screenshot with circles or arrows to highlight the error.

  2. Describe what steps you have performed in an attempt to resolve the issue.

About

Nothing to see here

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published