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

Optimize contribution guidelines #75

Open
mfranzke opened this issue Oct 5, 2022 · 1 comment
Open

Optimize contribution guidelines #75

mfranzke opened this issue Oct 5, 2022 · 1 comment
Assignees
Labels
community feedback documentation Improvements or additions to documentation hacktoberfest https://hacktoberfest.com/
Milestone

Comments

@mfranzke
Copy link
Member

mfranzke commented Oct 5, 2022

Currently we're having two sections for contributions within our README file – we should most likely merge this to one, and even also extract relevant information to the separate CONTRIBUTING.md file.

That file would additionally need some more rework, as we're currently mentioning the husky dependency, but especially for somebody new to the project don't mention how they should do this, as in general this dependency would get installed by the general npm install:
https://github.com/db-ui/core/blob/main/CONTRIBUTING.md?plain=1#L9

Besides that we should mention some prerequisites like e.g. nvm that would ensure the expected node version to be installed.

@mfranzke mfranzke added the documentation Improvements or additions to documentation label Oct 5, 2022
@mfranzke mfranzke added this to the Release 2.0 milestone Oct 5, 2022
@mfranzke mfranzke added the hacktoberfest https://hacktoberfest.com/ label Oct 5, 2022
@ErebusXAbyss
Copy link

I would like to work on this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community feedback documentation Improvements or additions to documentation hacktoberfest https://hacktoberfest.com/
Projects
None yet
Development

No branches or pull requests

2 participants