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

feat: add developer docs #228

Merged
merged 1 commit into from
Nov 10, 2021
Merged

Conversation

Callisto13
Copy link
Member

@Callisto13 Callisto13 commented Nov 8, 2021

Shiny new contrib docs!

What copy-paste? Who said anything about copy-paste? I will not stand for these accusations! (does it make it better if i copied from my past self?)

Might be easier to read fully rendered.

I have added our latest ADR process too (per slack discussion).

Can tweak anything 👍

There is a TODO (testing standards) but I will add that later as i would like to have a discussion around it first.

@codecov-commenter
Copy link

codecov-commenter commented Nov 8, 2021

Codecov Report

Merging #228 (0c14982) into main (fe9bb9f) will decrease coverage by 2.14%.
The diff coverage is 70.73%.

❗ Current head 0c14982 differs from pull request most recent head a75d385. Consider uploading reports for the commit a75d385 to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##             main     #228      +/-   ##
==========================================
- Coverage   55.81%   53.66%   -2.15%     
==========================================
  Files          44       46       +2     
  Lines        2012     2139     +127     
==========================================
+ Hits         1123     1148      +25     
- Misses        781      885     +104     
+ Partials      108      106       -2     
Impacted Files Coverage Δ
core/application/commands.go 71.66% <ø> (+2.70%) ⬆️
infrastructure/network/network_service.go 0.00% <0.00%> (ø)
pkg/planner/actuator.go 86.20% <ø> (ø)
pkg/validation/validate.go 100.00% <ø> (+12.50%) ⬆️
core/plans/microvm_create_update.go 57.53% <36.36%> (+2.65%) ⬆️
infrastructure/network/errors.go 50.00% <50.00%> (ø)
core/steps/network/interface_delete.go 90.90% <73.33%> (-9.10%) ⬇️
core/steps/network/interface_create.go 93.22% <75.00%> (-3.08%) ⬇️
infrastructure/network/utils.go 76.92% <76.92%> (ø)
core/plans/microvm_delete.go 60.00% <83.33%> (+3.13%) ⬆️
... and 5 more

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 15755b8...a75d385. Read the comment docs.

@Callisto13 Callisto13 added kind/documentation Documentation only kind/feature New feature or request labels Nov 8, 2021
@Callisto13 Callisto13 changed the title (feat): add developer docs feat: add developer docs Nov 8, 2021
@Callisto13 Callisto13 marked this pull request as ready for review November 9, 2021 12:16
@Callisto13 Callisto13 removed the kind/feature New feature or request label Nov 9, 2021
CONTRIBUTING.md Outdated Show resolved Hide resolved
@Callisto13 Callisto13 force-pushed the dev-docs branch 2 times, most recently from bb70ef2 to 88c0af1 Compare November 9, 2021 12:47
@Callisto13 Callisto13 force-pushed the dev-docs branch 2 times, most recently from 56833be to 9301380 Compare November 9, 2021 13:29
Copy link
Member

@richardcase richardcase left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One of the best contributing guides i've read!

.github/ISSUE_TEMPLATE/feature_request.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
@Callisto13 Callisto13 force-pushed the dev-docs branch 2 times, most recently from f6e8852 to 0c14982 Compare November 10, 2021 11:48
@Callisto13 Callisto13 linked an issue Nov 10, 2021 that may be closed by this pull request
Every issue will be assigned a `priority/<x>` label. The levels of priorities are:

- [`critical-urgent`](https://github.com/weaveworks/flintlock/labels/priority%2Fcritical-urgent): These are time sensitive issues which should be picked up immediately.
If an issue labelled `critical` is not assigned or being actively worked on,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit, maybe in this block all instances of cirtical could be changed to critical-urgent. But thats being a bit pedantic i feel.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oops sorry just saw this 😬

@Callisto13 Callisto13 merged commit fb613ae into liquidmetal-dev:main Nov 10, 2021
@Callisto13 Callisto13 deleted the dev-docs branch November 10, 2021 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Documentation only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create contributing guide
5 participants