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

Update CONTRIBUTING.md #44

Closed
wants to merge 10 commits into from
Closed

Update CONTRIBUTING.md #44

wants to merge 10 commits into from

Conversation

mordamax
Copy link

βœ„ -----------------------------------------------------------------------------

Thank you for your Pull Request! πŸ™ Please make sure it follows the contribution guidelines outlined in this
document
and fill out the
sections below. Once you're ready to submit your PR for review, please delete this section and leave only the text under
the "Description" heading.

Description

A concise description of what your PR is doing, and what potential issue it is solving. Use Github semantic
linking

to link the PR to an issue that must be closed once this is merged.

Integration

In depth notes about how this PR should be integrated by downstream projects. This part is mandatory, and should be
reviewed by reviewers, if the PR does NOT have the R0-Silent label. In case of a R0-Silent, it can be ignored.

Review Notes

In depth notes about the implementation details of your PR. This should be the main guide for reviewers to
understand your approach and effectively review it. If too long, use
<details>
.

Imagine that someone who is depending on the old code wants to integrate your new code and the only information that
they get is this section. It helps to include example usage and default value here, with a diff code-block to show
possibly integration.

Include your leftover TODOs, if any, here.

Checklist

  • My PR includes a detailed description as outlined in the "Description" and its two subsections above.
  • My PR follows the labeling requirements of this project (at minimum one label for T required)
    • External contributors: ask maintainers to put the right label on your PR.
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works (if applicable)

You can remove the "Checklist" section once all have been checked. Thank you for your contribution!

βœ„ -----------------------------------------------------------------------------

@mordamax
Copy link
Author

/cmd --help

Copy link

Command help:
usage: /cmd  [--help] [--continue-on-fail] [--quiet] [--clean] [--image IMAGE]
             {bench,fmt,update-ui} ...

A command runner for polkadot-sdk repo

positional arguments:
  {bench,fmt,update-ui}
                        a command to run
    bench               Runs benchmarks
    fmt                 Formats code (cargo +nightly-VERSION fmt) and configs
                        (taplo format)
    update-ui           Updates UI tests

options:
  --help                help for help if you need some help
  --continue-on-fail    Won't exit(1) on failed command and continue with next
                        steps.
  --quiet               Won't print start/end/failed messages in PR
  --clean               Clean up the previous bot's & author's comments in PR
  --image IMAGE         Override docker image '--image
                        docker.io/paritytech/ci-unified:latest'

### Command 'bench'
usage: /cmd bench [-h] [--continue-on-fail] [--quiet] [--clean]
                  [--image IMAGE]
                  [--runtime [{dev,westend,rococo,asset-hub-westend,asset-hub-rococo,bridge-hub-rococo,bridge-hub-westend,collectives-westend,contracts-rococo,coretime-rococo,coretime-westend,glutton-westend,people-rococo,people-westend} ...]]
                  [--pallet [PALLET ...]]

options:
  -h, --help            show this help message and exit
  --continue-on-fail    Won't exit(1) on failed command and continue with next
                        steps.
  --quiet               Won't print start/end/failed messages in PR
  --clean               Clean up the previous bot's & author's comments in PR
  --image IMAGE         Override docker image '--image
                        docker.io/paritytech/ci-unified:latest'
  --runtime [{dev,westend,rococo,asset-hub-westend,asset-hub-rococo,bridge-hub-rococo,bridge-hub-westend,collectives-westend,contracts-rococo,coretime-rococo,coretime-westend,glutton-westend,people-rococo,people-westend} ...]
                        Runtime(s) space separated
  --pallet [PALLET ...]
                        Pallet(s) space separated

**Examples**:
 Runs all benchmarks 
 /cmd bench

 Runs benchmarks for pallet_balances and pallet_multisig for all runtimes which have these pallets. **--quiet** makes it to output nothing to PR but reactions
 /cmd bench --pallet pallet_balances pallet_xcm_benchmarks::generic --quiet
 
 Runs bench for all pallets for westend runtime and continues even if some benchmarks fail
 /cmd bench --runtime westend --continue-on-fail
 
 Does not output anything and cleans up the previous bot's & author command triggering comments in PR 
 /cmd bench --runtime westend rococo --pallet pallet_balances pallet_multisig --quiet --clean


### Command 'fmt'
usage: /cmd fmt [-h] [--continue-on-fail] [--quiet] [--clean] [--image IMAGE]

options:
  -h, --help          show this help message and exit
  --continue-on-fail  Won't exit(1) on failed command and continue with next
                      steps.
  --quiet             Won't print start/end/failed messages in PR
  --clean             Clean up the previous bot's & author's comments in PR
  --image IMAGE       Override docker image '--image docker.io/paritytech/ci-
                      unified:latest'


### Command 'update-ui'
usage: /cmd update-ui [-h] [--continue-on-fail] [--quiet] [--clean]
                      [--image IMAGE]

options:
  -h, --help          show this help message and exit
  --continue-on-fail  Won't exit(1) on failed command and continue with next
                      steps.
  --quiet             Won't print start/end/failed messages in PR
  --clean             Clean up the previous bot's & author's comments in PR
  --image IMAGE       Override docker image '--image docker.io/paritytech/ci-
                      unified:latest'

@mordamax
Copy link
Author

/cmd update-ui

@mordamax
Copy link
Author

/cmd bench --pallet pallet_balances --runtime westend

1 similar comment
@mordamax
Copy link
Author

/cmd bench --pallet pallet_balances --runtime westend

Copy link

Command "bench --pallet pallet_balances --runtime westend" has started πŸš€ See logs here

@mordamax
Copy link
Author

/cmd update-ui

Copy link

Command "update-ui" has started πŸš€ See logs here

Copy link

Command "bench --pallet pallet_balances --runtime westend" has failed ❌! See logs here

Copy link

Command "update-ui" has finished βœ… See logs here

@mordamax
Copy link
Author

/cmd update-ui

Copy link

Command "update-ui" has started πŸš€ See logs here

Copy link

Command "update-ui" has finished βœ… See logs here

@mordamax
Copy link
Author

/cmd update-ui

Copy link

Command "update-ui" has started πŸš€ See logs here

Copy link

Command "update-ui" has finished βœ… See logs here

@mordamax mordamax force-pushed the master branch 14 times, most recently from a8a1ceb to 9cdbdc5 Compare September 17, 2024 15:39
@mordamax mordamax closed this Sep 26, 2024
@mordamax mordamax deleted the mak-inform branch September 26, 2024 08:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant