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

ZeoBot's Environment Prepared #3

Merged
merged 1 commit into from Nov 14, 2022
Merged

ZeoBot's Environment Prepared #3

merged 1 commit into from Nov 14, 2022

Conversation

zeobot[bot]
Copy link
Contributor

@zeobot zeobot bot commented Nov 14, 2022

ZeoBot's Environment Prepared.

The file is stored and will be read from the following location:

branch: `main`
path: .zeobot/config.yml
  • at the installation the default-branch was: main
  • the config file should be stored in the default-branch

@zeobot was added to this repo by @AdamOswald

@performance-testing-bot
Copy link

Unable to locate .performanceTestingBot config file

@mezidia-inspector
Copy link

Nice to meet you, @zeobot[bot]. Thank you for creating a pull request.
It's your first contribution, so read CONTRIBUTING.md, if you didn't do this.
There are some tasks for you:

  • Need at least one label
  • Need at least one assignee
  • Need a milestone
  • Make a pull request draft at first

To close issue send comment "close", to reopen - "reopen", to merge - "merge"

@difflens
Copy link

difflens bot commented Nov 14, 2022

View changes in DiffLens

@pull-request-quantifier-deprecated

This PR has 143 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Medium
Size       : +143 -0
Percentile : 48.6%

Total files changed: 1

Change summary by file extension:
.yml : +143 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@viezly
Copy link

viezly bot commented Nov 14, 2022

Changes preview:

Legend:

👀 Review pull request on Viezly

@zeobot
Copy link
Contributor Author

zeobot bot commented Nov 14, 2022

I've just created the configuration file

The default values are the following:

########################
#  Zeobot Config File  #
########################
# Configuration Begins #
########################

# zeobot defaults values for the installed repository
zeobot:
 # if enabled, zeobot will run for the repo
 enabled: true
 # zeobot's commands
 commands:
   # if enabled, zeobot will detect commands from comments
   enabled: false
   # write down the users with access to restricted commands
   listen_to:
     users:
 # zeobot's features
 features:
   # if enabled, zeobot will post comments
   can_comment: true

# Auto Assign (AA)
# on new pull request created assign people to it
auto_assign:
 # if enabled, AA will work for this repository
 enabled: true
 use_review_groups: false
 use_assignee_groups: false
 add_reviewers: true
 add_assignees: false
 number_of_assignees: 0
 number_of_reviewers: 0
 review_groups:
 assignee_groups:
 reviewers_to_add:
 assignees_to_add:
 skip_keywords:

# Autodelete Merged Branches (AMB)
# after successfully merging a pr, the branch will be deleted
autodelete_merged_branches:
 # if enabled, BIP will work for this repository
 enabled: true
 # branches with this name won't be deleted
 branches_to_exclude:

# Branch in Progress (BIP)
# pull requests marked with the '@zeobot-bip' label won't be merged
branch_in_progress:
 # if enabled, BIP will work for this repository
 enabled: true

# Contributors Commits Signed (CCS)
# pr's that contains unsigned commits will not be merged
contributors_commits_signed:
 # if enabled, CCS will work for this repository
 enabled: true
 # who is required to sign commits
 require_for:
   # if enabled, the organisation members will have to sign their commits
   members: false

# Enforce Branch Merge (EBM)
# enable the access only to some people to merge the branch
enforce_branch_merge:
 # if enabled, EBM will work for this repository
 enabled: true
 # branches where to apply the EBM
 branches_to_enforce:
 # who has the right to write to protected branches
 give_access_to:

# License Checker (LC)
# branches that contains files without license will not be merged
license_checker:
 # if enabled, LC will work for this repository
 enabled: true
 # allowed parameters
 allowed:
   # people/organisations who own the license
   copyright_holders:
   # licenses that are approved
   licenses:
 # files to check
 to_check:
   # with extension
   extensions:
 # files to ignore
 to_ignore:
   # with path
   files_path:

# Draft Release (DR)
# automatically make a draft release
draft_release:
 # if enabled, DR will work for this repository
 enabled: true
 # draft release template
 template:
   # release name template
   name: 'v$RESOLVED_VERSION'
   # release tag template
   tag: 'v$RESOLVED_VERSION'
   # release version template
   version: '$MAJOR.$MINOR.$PATCH'
   # release body/content template
   content: |
     ## Changes

     $CHANGES
 # release body/content changes template
 change:
   # body/content commit template for each row
   template: '- $TITLE (#$NUMBER) by @$AUTHORS'
   # title escapes
   title_escapes: '\<*_&'
 # pr's that contains this labels will
 labels_to:
   # be excluded from DR
   exclude:
   # be included in the release body
   include:
 # generate next version based on the labels
 version_resolver:
   # major - version category
   major:
     # these labels will influence the next version
     labels:
   # minor - version category
   minor:
     # these labels will influence the next version
     labels:
   # patch - version category
   patch:
     # these labels will influence the next version
     labels:
   # default value
   default: 'patch'
 # release content/body categories
 categories:
 # sort items in the body/content
 sort:
   # pull request are sorted
   pull_requests:
     # by
     by: 'merged_at'
     # direction
     direction: 'descending'

########################
#  Configuration Ends  #
########################

📌 This is an automatic response based on @AdamOswald's action
📌 To disable the comments from zeobot, type: 👉@zeobot disable comments👈

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

Successfully merging this pull request may close these issues.

None yet

1 participant