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

docs: basic structure for README.md and CONTRIBUTING.md #112

Merged
merged 6 commits into from
Oct 12, 2021

Conversation

yitsushi
Copy link
Contributor

@yitsushi yitsushi commented Oct 6, 2021

What this PR does / why we need it:

We currently have a blank README.md file. We need to change this and provide information about the project and also how to contribute.

Which issue(s) this PR fixes

Fixes #82

Special notes for your reviewer:

Checklist:

  • squashed commits
  • includes documentation

Release note:

Add README.md and CONTRIBUTING.md

@yitsushi yitsushi added the kind/documentation Documentation only label Oct 6, 2021
@codecov-commenter
Copy link

codecov-commenter commented Oct 6, 2021

Codecov Report

Merging #112 (49754c1) into main (ca14a16) will increase coverage by 0.16%.
The diff coverage is 83.33%.

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

@@            Coverage Diff             @@
##             main     #112      +/-   ##
==========================================
+ Coverage   40.09%   40.26%   +0.16%     
==========================================
  Files          32       32              
  Lines        1444     1448       +4     
==========================================
+ Hits          579      583       +4     
  Misses        789      789              
  Partials       76       76              
Impacted Files Coverage Δ
core/application/commands.go 64.93% <83.33%> (+1.92%) ⬆️

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 7b5ff28...c7c0102. Read the comment docs.

@yitsushi yitsushi force-pushed the 82-create-readme branch 2 times, most recently from a03a7ea to 9569064 Compare October 7, 2021 15:08
@yitsushi yitsushi marked this pull request as ready for review October 7, 2021 15:10
* Add README.md
* Add CONTRIBUTING.md

fixes liquidmetal-dev#82
README.md Outdated Show resolved Hide resolved
jmickey
jmickey previously approved these changes Oct 8, 2021
Copy link
Contributor

@jmickey jmickey left a comment

Choose a reason for hiding this comment

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

LGTM. @richardcase might have some more suggestions, but this seems like a good start!

README.md Outdated

* Companies that want to use Kubernetes, but they are tied to their physical
servers for technical or legal reasons.
* ???
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm pretty sure it's not done yet XD

Copy link
Contributor

Choose a reason for hiding this comment

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

WHOOPS. Missed that 🤦

@jmickey jmickey dismissed their stale review October 8, 2021 15:09

Not complete

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
yitsushi and others added 2 commits October 12, 2021 17:43
Same changes can be submitted to weaveworks/ignite as I copied a lot of stuff from there.

Co-authored-by: Claudia <[email protected]>
richardcase
richardcase previously approved these changes Oct 12, 2021
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.

LGTM

@richardcase richardcase merged commit 660390c into liquidmetal-dev:main Oct 12, 2021
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 README.md
5 participants