docs: define procedure for feature proposals - #92
Open
allessandrobianchi wants to merge 1 commit into
Open
Conversation
Closes sam#39 - Add docs/feature-proposals.md describing the end-to-end flow from idea to delivered feature: open an issue, document the feature as Pending, write tests, implement, and thoroughly comment with issue/wiki references. Links it from the README.
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
2 participants
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
Defines the procedure for taking a feature from idea to delivery, prioritizing documentation at every step.
Issues closed
Closes #39
What was implemented
docs/feature-proposals.md: the end-to-end procedure — open an issue, write the wiki documentation page as Pending, write tests (revising docs as requirements evolve), implement (revising docs as necessary), and thoroughly comment code and tests referencing the issue and wiki page. Includes a Definition of Done.README.textile: links to the new procedure.How each requirement was met
The issue asked for a written procedure covering: issue discussion, a Pending wiki page, tests with doc revision, implementation with doc revision, and thorough comments referencing issue + wiki — all present in
docs/feature-proposals.md, with documentation treated as a high-priority, first-class deliverable throughout.