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

Improve documentation on contributions to provide more instructions, tips, trick to make contributions easier #50

Open
visto9259 opened this issue Sep 18, 2024 · 2 comments
Assignees
Labels
Bug Something isn't working

Comments

@visto9259
Copy link
Contributor

Improve documentation to provide more instructions, tips, trick to make contributions easier.

As a new contributor who submitted contributions lately, I made many rookie mistakes that could have been avoided if I had known ahead of time, a few tips and tricks.

There are also expectations from maintainers on documenting changes and PR (ie provide details on what is being change). These expectations do not seem to be documented either.

There is no mention of running static analysis to improve quality

I propose to

  • Review and improve CONTRIBUTING.MD
  • Review and improve if needed, the issue and PR templates

You can assign the issue to me

@visto9259 visto9259 added the Bug Something isn't working label Sep 18, 2024
@visto9259
Copy link
Contributor Author

BTW this line in SUPPORT.md needs to be updated as well.

I would think that this should read

  • To report issues for a given repository, use that repository's issue tracker

Do you agree?

@koka500000
Copy link

F

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants