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

chore(BUX-506): update bux-server config description #419

Merged
merged 3 commits into from
Jan 29, 2024

Conversation

pawellewandowski98
Copy link
Contributor

Pull Request Checklist

  • πŸ“– I created my PR using provided : CODE_STANDARDS
  • πŸ“– I have read the short Code of Conduct: CODE_OF_CONDUCT
  • 🏠 I tested my changes locally.
  • βœ… I have provided tests for my changes.
  • πŸ“ I have used conventional commits.
  • πŸ“— I have updated any related documentation.
  • πŸ’Ύ PR was issued based on the Github or Jira issue.

Description

  • Added description for all config variables

@pawellewandowski98 pawellewandowski98 self-assigned this Jan 22, 2024
@pawellewandowski98 pawellewandowski98 requested a review from a team as a code owner January 22, 2024 14:37
@mergify mergify bot added the feature Any new significant addition label Jan 22, 2024
Copy link
Contributor

mergify bot commented Jan 22, 2024

Welcome to our open-source project @pawellewandowski98! πŸ’˜

Copy link

codecov bot commented Jan 22, 2024

Codecov Report

All modified and coverable lines are covered by tests βœ…

Comparison is base (6f0573e) 39.64% compared to head (d741e9e) 39.64%.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #419   +/-   ##
=======================================
  Coverage   39.64%   39.64%           
=======================================
  Files          47       47           
  Lines        1710     1710           
=======================================
  Hits          678      678           
  Misses        992      992           
  Partials       40       40           
Flag Coverage Ξ”
unittests 39.64% <ΓΈ> (ΓΈ)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Ξ” = absolute <relative> (impact), ΓΈ = not affected, ? = missing data
Powered by Codecov. Last update 6f0573e...d741e9e. Read the comment docs.

config.example.yaml Outdated Show resolved Hide resolved
config.example.yaml Outdated Show resolved Hide resolved
config.example.yaml Outdated Show resolved Hide resolved
config.example.yaml Outdated Show resolved Hide resolved
config.example.yaml Outdated Show resolved Hide resolved
config.example.yaml Outdated Show resolved Hide resolved
config.example.yaml Show resolved Hide resolved
config.example.yaml Outdated Show resolved Hide resolved
config.example.yaml Outdated Show resolved Hide resolved
config.example.yaml Outdated Show resolved Hide resolved
config.example.yaml Outdated Show resolved Hide resolved
Copy link
Contributor

@chris-4chain chris-4chain left a comment

Choose a reason for hiding this comment

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

Generally - I'm wondering if the underscore-prefixed fields e.g. _beef: with a comment Prefixed with "_", because it's unused by default make sense now. Maybe it would be better to set all fields in config.example and put an appropriate NOTE in the README.

README.md Outdated Show resolved Hide resolved
@pawellewandowski98 pawellewandowski98 force-pushed the feat-506-update-config-description branch from 13da7ca to d741e9e Compare January 26, 2024 11:17
@pawellewandowski98 pawellewandowski98 merged commit a508ba4 into master Jan 29, 2024
10 checks passed
@pawellewandowski98 pawellewandowski98 deleted the feat-506-update-config-description branch January 29, 2024 09:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Any new significant addition
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants