This section guides you through submitting an enhancement suggestion.

Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions.

When you are creating an enhancement suggestion, please include as many details as possible.

Before Submitting An Enhancement Suggestion

  • Check the Besu documentation. You might be able to find the enhancement already exists.
  • Perform a cursory search of project issues to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit a (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as issues. Provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. If you're providing code snippets in the issue, use backticks (````) to format the code snippets..
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots which help you demonstrate the steps where possible.
  • Explain why this enhancement would be useful to most users.
  • Does this enhancement exist in other clients?
  • Specify which version of the software you're using. You can get the exact version by running besu --version in your terminal.
  • Specify the name and version of the OS you're using.
  • No labels

2 Comments

  1. Nicolas MASSART

    Could we use Github discussion instead of issues for enhancement suggestions then once the idea is validated, we create the issue?
    It would remove some load in the issues list and clarify the backlog.
    It would favour some more brainstorming like mindset than issues with already well defined scope and idea.
    What do you think?

  2. Sally MacFarlane

    The process that we currently have for prioritising feature and enhancement requests uses GitHub issues, Discord for discussions and something like hackmd if people want to write up a more detailed proposal. I think adding GitHub discussions to this doesn't really add anything, but means another place where we have to check for new things.