hashgraph / hashgraph/guardian

Add comments to config file parameters

Open
#3,930 0 comments 0 reactions 1 assignee Claimed by @Pyatakov View on GitHub
Dominant language
TypeScript
Stars
146
Forks
186
Avg merge
2d 20h
Merged PRs (30d)
126

Description

### Problem description
We have so many config files, which needs to be configured before running Guardian such as `.guardian.config` etc. These config files have several parameters such as "IPFS_API_KEY", "ACCOUNT_ID" etc, but for some of the parameters, we do not have comments added, which shows description of those parameters, which might confuse the user and might miss the parameter configuration, which will lead to error during Guardian installation.

### Requirements
We need to add all the comments to all the parameters for all the config files, which will make sure the configuration is clear and users are well aware of each of the meaning of the parameter in the files.

### Definition of done
1. Adding all the parameters to all config files.
2. Testing and making sure Guardian launch is not affected.

### Acceptance criteria
Comments added to all the parameters of config files.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.