approvals / approvals/Approvals.NodeJS
.approvalsConfig example should be YAML
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 125
- Forks
- 46
- Avg merge
- 2m
- Merged PRs (30d)
- 16
Description
In the documentation, the approvalsConfig example file is written in JSON.
When testing it out, I get a YAML error, indicating the documentation is not reflecting the current state of Approvals.NodeJS.
I have version 3.0.5 here, installed via npm.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the documentation entry containing the .approvalsConfig example and compare it with the format accepted by Approvals.NodeJS 3.0.5. Update the example to YAML and verify it no longer produces the reported YAML error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nodejs
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100