boyney123 / boyney123/auto-comment

YML file location not clear

Open
#15 0 comments 4 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
24
Forks
18
PR merge metrics
No merged PRs in 30d

Description

## location of the auto-comment.yml file according to:
- README: `.github/auto-commnet.yml`
- probot page: `./github/auto-comment.yml`
- installation config: `./auto-comment.yml`

## img references:
- ![image](https://user-images.githubusercontent.com/52100648/113420258-a2eaf380-93e6-11eb-921b-4e074c6c3e6e.png)
- ![image](https://user-images.githubusercontent.com/52100648/113420286-ac745b80-93e6-11eb-868b-81fe257636c0.png)
- ![image](https://user-images.githubusercontent.com/52100648/113420330-beee9500-93e6-11eb-9551-2f1b480a9452.png)

It would really help users if the location is specified clearly (preferably in the `./.github/` folder)

Contributor guide

Open the contributing guide

Research direction

Start by reading the README and comparing its auto-comment.yml path with the Probot page and installation configuration references listed in the issue. Identify the intended canonical location, then update the conflicting documentation references so users see one consistent path; done means the README, Probot guidance, and installation instructions agree.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.