prpl Improvement Proposals (PRIPs) are the primary method for adding features to an PEG's repository. A PRIP could be best described as an informal RFC.
- 1 PRIPs process overview
- 2 Workflow diagram of PRIP Process
- 3 Create a new PRIP
PRIPs process overview
NOTE: This isn't a hard set of rules; nor do you have to do them in that order serially. You could finish coding your change before writing one word in a PRIP, for example. The risk in doing so is that you miss out on feedback when you could incorporate it at relatively low cost -- that is, relatively little rework. It's better to overcommunicate and overdiscuss.
The following list describes one approach for improving prpl OpenWrt using a PRIP:
Have an idea for improving prpl OpenWrt
Every new improvement comes from a community member having an idea. If you have an idea for prpl OpenWrt, start the PRIP process.
Sometimes, even though you have a good idea, you want to bounce the idea off some members of the community before you begin working on it. In that case, email the OpenWrt PEG mailing list with your idea and see if anyone has any thoughts.
Break it down, if necessary, to discrete ideas.
We don't want to lose the big picture but breaking down big ideas helps ensure you've thought through all the steps and helps others better understand your proposal.
Open a feature request
Add a feature request via Github Issues on the prpl OpenWRT issue tracker. Provide enough detail about what the improvement does and how it makes prpl OpenWRT better; that allows the triage team and attendees to offer feedback and, if all goes well, schedule the feature in an appropriate release.
Draft your PRIP
Get the ideas "down on paper." Use the Create A New PRIP tool to start creating your PRIP on the wiki. All you'll need is the issue number from the issue your created in the last step.
Get public feedback
You have many options for feedback: E-mail the prpl OpenWrt mailing list describing the proposed change. Blog posts. Tweets. Discussions at online meetings.
Capture the feedback
Use the feedback to improve your PRIP. Add useful suggestions. Address weaknesses. List alternatives. Consider what it means if you're getting lots of negative feedback. (But don't let the haters get to you.)
Update your PRIP
Complete all the sections of the PRIP. Keep discussing on the mailing list. When you're done, email the prpl OpenWrt mailing list and ask for final approval of your PRIP. This approval is via majority vote.
Feature branch is added
If your PRIP is approved, a feature branch named for your PRIP will be added to the prpl OpenWrt Github repository. The feature branch name uses the formula PRIPn where n is the PRIP number.
Collaborate on the feature
Now that your feature branch has been added, collaborate with others on the feature using the Merge-then-review workflow.
Workflow diagram of PRIP Process
The content of this page is licensed under the Microsoft Reciprocal License
The content of this page is a derivative work of , Copyright (c) 2004, Outercurve Foundation.
Create a new PRIP
This tool will help you start a new PRIP to add a feature to OpenWrt. To get started, you'll need the number of the Github issue number for your feature request (it's at the end of the URL for your Github issue) and a quick one-line summary of your feature proposal.