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

WIP: adds draft structure for copilot docs #641

Closed

Conversation

george-silva
Copy link

@george-silva george-silva commented Dec 16, 2021

What

  1. Creates documentation for deployment with AWS Copilot

fixed: #640

Why

We're using this and I think it's good to give it back.

Caveats

DRAFT for now.

@pull-request-quantifier-deprecated

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


Quantification details

Label      : Extra Small
Size       : +15 -0
Percentile : 6%

Total files changed: 2

Change summary by file extension:
.md : +15 -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 detetcted.
  • 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.

@CLAassistant
Copy link

CLAassistant commented Dec 16, 2021

CLA assistant check
All committers have signed the CLA.

@sourcelevel-bot
Copy link

Hello, @george-silva! This is your first Pull Request that will be reviewed by SourceLevel, an automatic Code Review service. It will leave comments on this diff with potential issues and style violations found in the code as you push new commits. You can also see all the issues found on this Pull Request on its review page. Please check our documentation for more information.

@codecov
Copy link

codecov bot commented Dec 16, 2021

Codecov Report

Merging #641 (6051db2) into main (af99710) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #641   +/-   ##
=======================================
  Coverage   77.73%   77.73%           
=======================================
  Files          21       21           
  Lines        2668     2668           
=======================================
  Hits         2074     2074           
  Misses        494      494           
  Partials      100      100           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update af99710...6051db2. Read the comment docs.

@avelino
Copy link
Member

avelino commented Dec 23, 2021

@george-silva was able to evolve with the evolution of the documentation, can I help you with something?

@avelino avelino changed the title [DRAFT] adds draft structure for copilot docs WIP: adds draft structure for copilot docs Dec 23, 2021
@george-silva
Copy link
Author

@avelino hey man, not yet. Last week of the year at work and we have a demo today, so I was very short on time. Most likely I'll be able to finish next week/first week of 22.

Happy holidays.

@avelino
Copy link
Member

avelino commented Jan 5, 2022

Our file structure in the documentation has changed, I am closing this issue, but look forward to your contribution to the copilot documentation.

@avelino avelino closed this Jan 5, 2022
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.

Documentation Amazon ECS using AWS Copilot
3 participants