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.md file content doesn't match its purpose #355

Open
ROMEEZHOU opened this issue Feb 15, 2023 · 1 comment
Open

CONTRIBUTING.md file content doesn't match its purpose #355

ROMEEZHOU opened this issue Feb 15, 2023 · 1 comment

Comments

@ROMEEZHOU
Copy link

ROMEEZHOU commented Feb 15, 2023

It seems to me that a typical CONTRIBUTING.md file is supposed to describe how one can contribute to this project (e.g. fix a bug, add a feature...) However, now CONTRIBUTING.md is mainly talking about how to install and run use this visualizer. Also, I noticed that some issues are talking about having trouble using this visualizer. Renaming the current CONTRIBUTING.md to INSTALLING.md and having another CONTRIBUTING.md specifically focusing on how people can communicate with the leadership or help polishing the project could be more proper.

@lxzzz
Copy link

lxzzz commented Feb 15, 2023 via email

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

2 participants