...
| Info |
|---|
This is not the complete workflow. See the Quick Start if you are familiar with Git and PBS, otherwise see the detailed development instructions. |
| Excerpt | ||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Document your design
If you're working on a feature or a complex bug, document it in the space used for project designs on Confluence. Put your design, called an External Design Document or EDD, in your design page. Use the JIRA ID when you create your page. See this example. Some bugs are small enough that they don't need documenting. If you are not sure, ask on the development forum. Get comments on your designGet Comments on Your DesignAnchor |
Initiate a discussion of your idea or bug fix by starting a topic for it on the PBS Pro development forum, with a pointer to your design page. If the feature is on the roadmap, mention that in your email. Get review comments from community members about your bug fix or design. Make sure review comments are solicited and posted in the development forum, and not on the wiki. All discussion of your design and code should take place on the development forum. Get approval for your design
For features or complex bugs, get sign-off of the high-level design approach from two people: one maintainer and one other contributor (who can be a maintainer). If you took a complex feature and broke it down into sub-tasks, and you are working on a sub-task, you need two sign-offs on the design for your sub-task. Make sure that all approvals are posted in the development forum, not on the wiki. |
...