-
Notifications
You must be signed in to change notification settings - Fork 50
add CONTRIBUTING.md with log level guidelines #212
Conversation
For reference, the k8s logging guidelines: https://github.com/kubernetes/community/blob/master/contributors/devel/logging.md |
CONTRIBUTING.md
Outdated
responding to API calls. | ||
* `debug` for other occurrences, uncertain significance but eventually | ||
helpful in troubleshooting; e.g. workflow instance state transitions. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
👍 |
CONTRIBUTING.md
Outdated
not inevitably lead to one.) | ||
* `info` for other significant occurrences; e.g. starting and stopping, | ||
responding to API calls. | ||
* `debug` for other occurrences, uncertain significance but eventually |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is eventually
the right word here? I would go for possibly
or similar non-promising words.
README.md
Outdated
@@ -32,14 +32,15 @@ easily be added. | |||
|
|||
## Key concepts | |||
|
|||
The key type of information that Styx concerns itself with are Workflows. A Workflow is either | |||
The key concept that Styx concerns itself with are Workflows. A Workflow is either |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the … are Workflows
should be … is Workflows
.
Please reflow the paragraphs that you changed, some lines are too long and some too short. |
Codecov Report
@@ Coverage Diff @@
## master #212 +/- ##
============================================
- Coverage 69.25% 69.23% -0.03%
+ Complexity 861 860 -1
============================================
Files 111 111
Lines 3689 3689
Branches 207 207
============================================
- Hits 2555 2554 -1
Misses 1064 1064
- Partials 70 71 +1 |
No description provided.