docs: add security policy, releasing guide, roadmap and issue templates - #51
Merged
Merged
Conversation
A bug report is only useful with the Xcode, device and runtime it happened on, so the form asks for them.
Says where the limitations list is going, with the uncertain items marked as uncertain rather than promised.
Mastersam07
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What: Issue forms for bug reports and feature requests, a
SECURITY.md, aRELEASING.mdfor maintainers, aROADMAP.md, and changelog entries for what has landed since it was written.The bug form requires the app version, macOS, Xcode version and build, device, runtime and Apple silicon or Intel, and points at
odhub doctor, which prints nearly all of it.SECURITY.mdsays plainly what the app does to a machine, since loading private frameworks out of someone's Xcode is unusual enough to state out loud.RELEASING.mdcovers the process, the secret names, how to read a notarization log and what to do when a release fails at each stage.ROADMAP.mdsays where the README's limitations list is going, with the uncertain items marked as uncertain rather than promised.Verification: Both issue forms parse as YAML.
scripts/changelog-section.py 0.1.0still reads the changelog and still exits 1 for a version that is not there. Repository topics checked: the eight intended ones were already set.Follow-ups: The repository description claims deep links, push, proxy certs and hot reload. Those are on the roadmap, not in the product, so the description is ahead of the code. Left alone rather than changed quietly, since it is public positioning.