forcedotcom / forcedotcom/git2gus

config.json should support comments

Open
#167 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
28
Forks
14
PR merge metrics
No merged PRs in 30d

Description

As a repository owner of a repository configured to use git2gus, I'd like the `.git2gus/config.json` file to support comments. So that I can know what this oddball config file is doing without documenting it in a separate file.

```json
{
// Reference: https://lwc-gus-bot.herokuapp.com/
// GitHub App: https://github.com/apps/git2gus
"productTag": "XXXXXXXXX",
"defaultBuild": "my default build"
}
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the code that reads `.git2gus/config.json` and checking how the current JSON is parsed. Verify the chosen comment-support behavior against the example in this issue, while preserving `productTag` and `defaultBuild`; done means repositories can use comments in this configuration file.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.