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

chore: added templates etc to enable contributions #713

Closed
wants to merge 1 commit into from

Conversation

taeh98
Copy link
Collaborator

@taeh98 taeh98 commented Oct 3, 2023

Hey @hossein-zare, I hope you're doing well!

I've made some stuff that will help people contribute to the repo in the future:

  • a CONTRIBUTING.md guidance file to improve the quality of contributions and help people who want to contribute to know how to do so
  • a pull request template to standardise them and make them easier to review
  • issue templates to improve the quality of issues => improve maintainers' ability to handle them
  • some other minor things too

When you get time, please could you take a look and let me know what you think of the general idea and what I've made? Thanks :)

@taeh98 taeh98 requested a review from hossein-zare October 3, 2023 23:30
@taeh98 taeh98 force-pushed the templates branch 4 times, most recently from 2ee7747 to b3e1d49 Compare October 4, 2023 16:59
@hossein-zare
Copy link
Owner

Hey,

I appreciate the changes.
Some of the templates are complicated and confusing as I personally don't provide all the information or answer the questions asked when reporting a bug or I may give up, I'm lazy 😕.
Please keep them as simple as possible or Submit them in a separate PR, I'll edit them later.

Thanks. 🙂

@taeh98 taeh98 force-pushed the templates branch 2 times, most recently from d28091a to 3542f1e Compare October 4, 2023 23:47
@taeh98
Copy link
Collaborator Author

taeh98 commented Oct 4, 2023

Hey,

I appreciate the changes. Some of the templates are complicated and confusing as I personally don't provide all the information or answer the questions asked when reporting a bug or I may give up, I'm lazy 😕. Please keep them as simple as possible or Submit them in a separate PR, I'll edit them later.

Thanks. 🙂

Hey @hossein-zare

I guess it's a balance. At the moment, a lot of the issues are low quality, without all the info needed to follow them up properly. On the other hand, yeah, it might dissuade people from making an issue if they have to fill out a lot of stuff. At the same time, if someone really does have a bug/feature request/problem, I think they will be motivated enough to fill them out (maybe even lazily, missing or deleting some stuff).

I'll have another look at some point and see if I can strip anything back from them. In the meantime, I merged in some unrelated but straightforward stuff, so it's just the templates and contributing file in this PR now, making it easier to review.

Thanks!

@taeh98 taeh98 force-pushed the templates branch 4 times, most recently from ae45dd0 to b1ae8f3 Compare October 7, 2023 01:22
@taeh98
Copy link
Collaborator Author

taeh98 commented Oct 6, 2024

Going to make separate PRs and branches for issue templates and the PR template.

@taeh98
Copy link
Collaborator Author

taeh98 commented Oct 6, 2024

New PR for issue templates: #765

New PR for pull request template: #764

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

Successfully merging this pull request may close these issues.

2 participants