docs: polish public contribution surfaces - #11
Merged
Conversation
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
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.
Summary
Improves the public writing surfaces for OpenNotes.
Why
Release notes, PRs, and issue templates are part of the project. They should help users and contributors understand what changed, how to report problems, and what standard a contribution should meet.
Changes
CONTRIBUTING.mdas a maintainer-facing guide.docs/release-writing.mdfor future releases.v0.1.1andv0.1.2.Testing
git diff --checkgh release view v0.1.1gh release view v0.1.2gh pr view 8gh pr view 10Release note