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

Add bug, feature, release templates #1392

Merged
merged 3 commits into from
Jan 18, 2022
Merged

Add bug, feature, release templates #1392

merged 3 commits into from
Jan 18, 2022

Conversation

eloquence
Copy link
Member

@eloquence eloquence commented Jan 11, 2022

Adds bug and issue templates with language largely taken from the SecureDrop server repo. I've incorporated @ninavizz's proposed changes in freedomofpress/securedrop#6175 with some modifications; if you review this PR, please also review Nina's, so we can keep language in sync between the two.

The release template is new. It should resemble previous release tickets like #1275, with two notable differences:

  • I've added placeholders for RM and Deputy RM roles
  • I've added a pre-flight testing step using apt-qa.

This assumes that we'll want to continue to do most QA using nightlies (which does have the benefit of high developer agility -- we can build those quickly and on-demand without worrying about RC increments) while getting important pre-release confidence in our build results. Happy to describe a different process, e.g., if we want to instead use the release branch/RC builds model for the next release.

@eloquence eloquence requested a review from a team as a code owner January 11, 2022 01:51
## How will this impact [SecureDrop users](https://github.com/freedomofpress/securedrop-ux/wiki/Users)?
<!-- How do you feel this change might impact SecureDrop's usability, accessibility, or usefulness—and specifically, for which users? Has anecdotal feedback from users influenced this change? Does evidence exist from user research to support this idea? Could design or user research efforts be helpful to support a change? -->

## How would this affect SecureDrop's [threat model](https://docs.securedrop.org/en/stable/threat_model/threat_model.html)?
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, let's link to the securedrop workstation threat model

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding multiple links in these templates can get a bit unwieldy, so instead I've opened a separate docs PR to make the SDW threat model a bit more discoverable:
freedomofpress/securedrop-docs#302

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#302 has been merged. I still think it makes more sense for a developer to be directed directly to the SDW threat model, because if you follow the https://docs.securedrop.org/en/stable/threat_model/threat_model.html link, you'll have to read about the old SVS and other pieces that are different in the new architecture.

Copy link
Member Author

@eloquence eloquence Jan 18, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, switched the links - that one also links back to the SD server/classical architecture threat model, in any event.

@eloquence eloquence force-pushed the add-issue-templates branch from 7c995b9 to 242c129 Compare January 11, 2022 01:54
## How will this impact [SecureDrop users](https://github.com/freedomofpress/securedrop-ux/wiki/Users)?
<!-- How do you feel this change might impact SecureDrop's usability, accessibility, or usefulness—and specifically, for which users? Has anecdotal feedback from users influenced this change? Does evidence exist from user research to support this idea? Could design or user research efforts be helpful to support a change? -->

## How would this affect SecureDrop's [threat model](https://docs.securedrop.org/en/stable/threat_model/threat_model.html)?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, let's link to the securedrop workstation threat model

.github/ISSUE_TEMPLATE/feature_request.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/release.md Show resolved Hide resolved
@gonzalo-bulnes
Copy link
Contributor

All three templates read well, and are looking very good IMHO 👍

Copy link
Contributor

@sssoleileraaa sssoleileraaa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changes look good to me! thanks :)

@sssoleileraaa sssoleileraaa merged commit 40fb099 into main Jan 18, 2022
@sssoleileraaa sssoleileraaa deleted the add-issue-templates branch January 18, 2022 20:07
@sssoleileraaa sssoleileraaa mentioned this pull request Jan 26, 2022
26 tasks
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.

3 participants