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(meta): Create issue templates and PR template, add authors.md #835

Draft
wants to merge 38 commits into
base: main
Choose a base branch
from

Conversation

simonsan
Copy link
Contributor

@simonsan simonsan commented Aug 19, 2023

To make it easier for the users and us to understand what is happening and why, and what the preconditions are.

The rendered issue form template can be seen here:
https://github.com/rustic-rs/rustic/blob/simonsan-patch-1/.github/ISSUE_TEMPLATE/bug_report.yml

The rendered feature request form template can be seen here:
https://github.com/rustic-rs/rustic/blob/simonsan-patch-1/.github/ISSUE_TEMPLATE/feature_request.yml

Blocked by: Needs adoption to rustic_core extraction to own repository. No choice needed in templates.

To make it easier for the users and us to understand what is happening and why, and what the preconditions are.
@simonsan simonsan added C-enhancement Category: New feature or request A-meta Area: Project wide A-ui-ux Area: Related to user interfaces and user experience S-waiting-for-review Status: PRs waiting for review labels Aug 19, 2023
@simonsan simonsan requested a review from aawsome August 19, 2023 02:23
@simonsan simonsan changed the title Create bug_report.md template Create issue templates and PR template, add authors.md Aug 19, 2023
@simonsan simonsan marked this pull request as draft August 19, 2023 04:21
@simonsan simonsan marked this pull request as ready for review August 19, 2023 06:40
Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>
Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>
Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>
Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>
Signed-off-by: simonsan <14062932+simonsan@users.noreply.github.com>
@simonsan
Copy link
Contributor Author

simonsan commented Sep 7, 2023

Added note to search our external docs as well, before opening an issue.

@simonsan simonsan changed the title Create issue templates and PR template, add authors.md chore(meta): Create issue templates and PR template, add authors.md Sep 11, 2023
@simonsan
Copy link
Contributor Author

Could you give it a rough look, @aawsome because I'm unsure if the direction is fine? Thanks a lot!

@aawsome
Copy link
Member

aawsome commented Sep 11, 2023

What about the other (existing) authors which already contributed to the project?

@simonsan
Copy link
Contributor Author

What about the other (existing) authors which already contributed to the project?

When added, we can open an issue and tag them to please leave their name, would be my proposal. But at some point we might want to start? Better late than never kind of style

@simonsan simonsan added S-blocked Status: Blocked from merging/working on due to some issue and removed S-waiting-for-review Status: PRs waiting for review labels Sep 18, 2023
@simonsan simonsan marked this pull request as draft September 18, 2023 15:55
@simonsan
Copy link
Contributor Author

simonsan commented Oct 2, 2023

What about the other (existing) authors which already contributed to the project?

Note for us (taken from git-cliff): A list of contributors can be derived using curl -s https://api.github.com/repos/orhun/git-cliff/contributors | jq -r .[].login | xargs -I {} echo "- [ ] @{}"

@nardoor
Copy link
Contributor

nardoor commented Aug 25, 2024

Hello !
I have 3 propositions/interrogations about the templates.

  • Checklist could be at the beginning of the template, I can totally imagine someone filling it all before the checklist reminds him/her of something the person didn't do
  • I expected some prompt about the .toml config, is there any reason there isn't one ? (for the issue template)
  • satisfaction questions to me are a bit "off topic" in an issue template or PR template, to me a better place for such a survey could be the discord? or some in pinned issue (if that exists my bad for not knowing)

Let me know what you think about this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-meta Area: Project wide A-ui-ux Area: Related to user interfaces and user experience C-enhancement Category: New feature or request S-blocked Status: Blocked from merging/working on due to some issue
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants