Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Creating a Wallet Feature Guidelines Document #28062

Open
ishaanam opened this issue Jul 10, 2023 · 3 comments
Open

Creating a Wallet Feature Guidelines Document #28062

ishaanam opened this issue Jul 10, 2023 · 3 comments

Comments

@ishaanam
Copy link
Contributor

It would be useful to the project if there was a document detailing what features are considered "out of scope" of the Bitcoin Core Wallet. This would make evaluating wallet PRs that add features easier for reviewers. It would also be useful to contributors so that they can get a better sense of which features are more likely to get merged. I'm curious if anybody else thinks that such a document would be useful, and if there are any guidelines that should be added. These guidelines would probably be more directed towards things that are unlikely to get merged, rather than things that we find acceptable.

Some examples of guidelines include the following:

  • Features shouldn't call any 3rd party APIs
  • Features shouldn't require any major changes to how the other parts of Bitcoin Core work
@recursive-rat4
Copy link

I'd rather see it more useful with an opposite list of what is in scope, for example:

  • The Wallet should improve an user experience when that does not compromise the security
  • The Wallet must use the Bitcoin P2P network when an interaction with the outside world is desired
  • The Wallet should implement new features that got standardized as BIPs

@GBKS
Copy link

GBKS commented Jul 16, 2023

I think both lists are important. Maybe you can kick off that effort?

I can't speak to the core wallet, but with the related GUI project I am helping with, we are trying to create solid design documentation from the start (see here), which may also end up including a good amount of feature specs. We're still early in this, but I do think it's worth the effort to document things well. It gets easier to make decisions, newcomers can more easily understand the goals and status, you avoid repeatedly having the same conversations, etc.

@Mirror-Tang
Copy link

I also believe that both of these are needed and should be described as "what is a good Bitcoin core wallet" rather than limiting it. Perhaps we can start working together by creating a public Google document?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants