Bugs, improvements, and feature requests should be submitted so that they are actionable by developers. If you're unsure or just have a question use the forum, a GitHub issue can be created later if it is necessary.

Always search for similar topics already created on the forum or here on GitHub before creating a new one, but don't hijack threads that look somewhat similar but are not necessarily the same or have the same root cause.

Bugs

For a bug report to be actionable, it should follow the following template:

Steps to reproduce

  1. On Ubuntu 22.04
  2. Run subspace-farmer-ubuntu-x86_64-gemini-1b-2022-jun-18 farm from official release
  3. Observe an error

Expected result

Farmer starts successfully

What happens instead

This error is reported:

error: The following required arguments were not provided:
    --reward-address <REWARD_ADDRESS>
    --plot-size <PLOT_SIZE>

USAGE:
    subspace-farmer-ubuntu-x86_64-gemini-1b-2022-jun-18 [OPTIONS] --reward-address <REWARD_ADDRESS> --plot-size <PLOT_SIZE>

For more information try --help

This is an invalid bug report, of course, but you get the idea of what it should look like. Try to provide as much useful information as possible, but not too much and without rambling, so that developers can quickly diagnose and address it.

Improvements and feature requests

When there is something that can be improved or a feature is lacking, it is probably a good idea to start with the forum and search for similar ideas and if there isn't a topic already, create one to see if this would be a welcome change.

Again, try to discuss with wider audience whether it is a good idea before reaching out to maintainers directly.

When it is necessary to create an issue here, try to describe in a concise way what would the improvement or new feature look like, potentially using a similar template as for reporting bugs describing expected user flow there.