You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There is a mechanism to ensure that make docsgen-cli is run automatically on merge to the master branch.
Why Important
The docsgen-cli command auto-generates CLI documentation. In instances where contributors push a single line commit during a review, it might cause the docsgen-cli check to fail. This requires the person writing the PR to re-run make docsgen-cli, often context switching and waiting XX-minutes (TODO: write down time it takes) for the command to finish.
Additionally, most new contributors to Lotus are not aware of the need to run this command and running this automatically on merge can help alleviate some chores needed to do when contributing to the codebase.
User/Customer
Lotus contributors and maintainers.
Notes
The text was updated successfully, but these errors were encountered:
Done Criteria
There is a mechanism to ensure that
make docsgen-cli
is run automatically on merge to the master branch.Why Important
The
docsgen-cli
command auto-generates CLI documentation. In instances where contributors push a single line commit during a review, it might cause thedocsgen-cli
check to fail. This requires the person writing the PR to re-run make docsgen-cli, often context switching and waiting XX-minutes (TODO: write down time it takes) for the command to finish.Additionally, most new contributors to Lotus are not aware of the need to run this command and running this automatically on merge can help alleviate some chores needed to do when contributing to the codebase.
User/Customer
Lotus contributors and maintainers.
Notes
The text was updated successfully, but these errors were encountered: