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

Contributing Guidelines and devDependencies #87

Open
nemchik opened this issue Apr 7, 2021 · 0 comments
Open

Contributing Guidelines and devDependencies #87

nemchik opened this issue Apr 7, 2021 · 0 comments

Comments

@nemchik
Copy link
Contributor

nemchik commented Apr 7, 2021

I'm submitting a...


[ ] Regression (a behavior that used to work and stopped working in a new release)
[ ] Bug report  
[ ] Performance issue
[ ] Feature request
[x] Documentation issue or request
[ ] Support request
[ ] Other... Please describe:

Current behavior

When looking into how to contribute to this repo there is a lack of information about tooling.

Expected behavior

https://github.com/namics/webpack-config-plugins/tree/master/.github/CONTRIBUTING.md file that would explain the globally installed tools and processes for contributing to this repository. It would also be great if the devDependencies could include these tools so that installing them globally is not required at all. An example would be
https://github.com/namics/webpack-config-plugins/blob/6bf7421bf492dba2d1b62e1889c3970c2f48b4bf/package.json#L15
using git-cz

Minimal reproduction of the problem with instructions

Clone the repository to a system with no globally installed npm packages. Put the repository in front of a new developer who is unfamiliar with the practices of the current developers and past contributors.

What is the motivation / use case for changing the behavior?

I would personally like to contribute to this repository, and in general having a contributing guideline and including devDependencies for all used tooling prevents the need for globally installing tools that are expected to be used while contributing.

Environment

Removed as irrelevant.

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

No branches or pull requests

2 participants