hyperledger / fabric

Hyperledger Fabric is an enterprise-grade permissioned distributed ledger framework for developing solutions and applications. Its modular and versatile design satisfies a broad range of industry use cases. It offers a unique approach to consensus that enables performance at scale while preserving privacy.
https://wiki.hyperledger.org/display/fabric
Apache License 2.0
15.67k stars 8.82k forks source link

Missing argument in help information for command "peer lifecycle chaincode install" #4976

Open jmmunoz-kolokium opened 2 weeks ago

jmmunoz-kolokium commented 2 weeks ago

https://github.com/hyperledger/fabric/blame/0afafb845746653c19c9e815060998c418cad436/docs/source/commands/peerlifecycle.md#L119

In my opinion, the help information for this command is missing the package file parameter which should come after the word "install".

satota2 commented 2 weeks ago

@jmmunoz-kolokium Thank you for the report. I agree with your observation that the parameter is missing and should be added. The command should be updated as follows:

peer lifecycle chaincode install [packageFiles] [flags]

Would you be interested in creating a PR to fix this, or was your intention to simply report the bug? If you'd like to handle the PR, your contribution would be very welcome. If it's the latter, I can go ahead and create a PR for this.

jmmunoz-kolokium commented 2 weeks ago

@satota2 , Thank you for your reply.

Since this is my first contribution, I would be interested on handling this PR so I can see the full process.

I will create the PR as soon as possible, after reading the contribution guide.

Regards

satota2 commented 2 weeks ago

@jmmunoz-kolokium Thank you for your contribution! I look forward to seeing your PR. If you have any questions along the way, feel free to ask.

jmmunoz-kolokium commented 1 week ago

I have just created the pull request (my first one!). I hope it sticks to the project guidelines.

https://github.com/hyperledger/fabric/pull/4989