Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

issue report template #7

Open
pi0 opened this issue Feb 15, 2024 · 3 comments
Open

issue report template #7

pi0 opened this issue Feb 15, 2024 · 3 comments

Comments

@pi0
Copy link
Owner

pi0 commented Feb 15, 2024

do we maybe want to add an issue template to https://github.com/pi0/config-dir that people can easily copy to make module authors aware of the project?

It should include:

  • The problem
  • The solution
  • About the project (started by you etc.)
  • Resources for how to integrate this?

I think this would motivate a lot more people to open issues on their favorite modules, with the only downside being that it may encourage spam, if people do not check if an issue has been opened yet.

Originally posted by @zoey-kaiser in nuxt-modules/tailwindcss#808 (comment)

@zoey-kaiser
Copy link
Collaborator

zoey-kaiser commented Feb 15, 2024

## Description

Due to a lack of standards for where tools store their configuration, the number of top-level configuration files in projects is increasing day by day. See [.config dir proposal](https://github.com/pi0/config-dir) for more context.

## Suggested solution

I propose supporting `.config/NAME.js` and `.config/NAME.config.js` as alternative places to check and load the configuration if the top-level `NAME.config.js` does not exist to unblock adopting this new convention across the ecosystem.

While it can take a while to onboard more tools with this new convention, it will be an egg-and-chicken problem to adopt a new convention like this unless more mainstream tools onboard to support it.

### Implementation

It seems we can easily append .config/ variants to DEFAULT_CONFIG_FILES array.

## Alternatives

See [relevant discussions](https://github.com/pi0/config-dir/discussions).

@kevinwolfcr
Copy link

@zoey-kaiser thanks! I think it makes sense to put the content within a markdown code block for easier copy-paste.

@pacifiquem
Copy link

This sounds like a great idea 👍 💯
It'll be easier for us to suggest this convention to the repos.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants