Additional Config File Options
Maintainers usually reply within 1 day
Nobody has claimed this yet.
- #555 by @matbrgz — closed without merging
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 68/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- javascript
- Domain
- cli
Research direction
Start at the CLI's existing config-file discovery entry point and trace how the current .all-contributorsrc path is selected. Check nearby tests and configuration documentation, then verify that the three proposed paths are supported in the stated priority order and that the recommended filename is documented.
Written by the indexing model from the issue text.
Description
Is your feature request related to a problem? Please describe.
I believe there are several issues with the current standard of the config file being .all-contributorsrc in the root of the repo:
- Lack of extension makes the format ambiguous to some editors
- Config files in the root clutter things up and make the repo less readable, in my opinion
Describe the solution you'd like
I would propose supporting the following configs, with the CLI using the first one detected:
.all-contributors.json- This could potentially become the new standard recommended in the docs, also?
.config/all-contributors.json.all-contributorsrc
Describe alternatives you've considered
Question not applicable.
Additional context
Adding support for .config directory is inspired by https://github.com/pi0/config-dir, a growing movement to try and organize config files in a set directory rather than the repo's root.
Additionally, I would be happy to contribute a PR for this is there is interest from the maintainers.
Thanks!
- Dominant language
- JavaScript
- Stars
- 424
- Forks
- 151
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 15
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from all-contributors/cli
-
Unquoted commit message is causing `npx all-contributors add` to fail on v7.0.0Possibly taken @stchigel claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
all-contributors/cli#587 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
all-contributors/cli#586 ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
all-contributors/cli#584 ·
Maintainers usually reply within 1 day
-
[BUG]: Markdown provided in `types[key].link` is injected as-is into HTMLAnchorElement's href attributePossibly taken @theworker02 claimed this 34 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 61/100
all-contributors/cli#520 · 1 comment ·
Maintainers usually reply within 1 day
-
Consider adding a PR title checker to enforce angular / conventional commitsMay be free again A pull request for this issue was closed without being merged. Opentype: ci type: enhancement type: infrastructure
Difficulty 2/5 1-3 hours Newbie friendliness 42/100
all-contributors/cli#482 · 3 comments · 1 reaction ·
Maintainers usually reply within 1 day
All issues in all-contributors/cli
Similar issues
-
check:failed logos:add
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
iptv-org/database#38874 · 1 comment ·
Maintainers usually reply within 4 days
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
githubnext/gh-aw-workshop#5193 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
agent/quality stage/040-covered-by-pr testing
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
cncf/endusers#2031 · 2 comments ·
Maintainers usually reply within 1 day