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.

Sign up for GitHub

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

Jump to bottom

Add a contribution guide #73

Closed
hatemhelal opened this issue Sep 5, 2023 · 0 comments · Fixed by #91
Closed

Add a contribution guide #73

hatemhelal opened this issue Sep 5, 2023 · 0 comments · Fixed by #91
Assignees
@hatemhelal

Comments

@hatemhelal
Copy link
Contributor

hatemhelal commented Sep 5, 2023 •
edited
Loading

A good contribution guide should give new contributors an overview from both the macro-level down to the micro-level. Some concrete examples:

  • describes goals and non-goals of the project
  • overall package level structure, a rough map of where to find things
  • testing strategy
  • a reproducible development environment setup
  • etc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hatemhelal hatemhelal

Labels
None yet
Projects
None yet
Milestone
No milestone
1 participant
@hatemhelal