Skip to content

How to Introduce Software Design Patterns

Henne Vogelsang edited this page Oct 18, 2023 · 8 revisions

Steps to prepare your design pattern proposal and get it approved by the team:

  1. In the wiki's sidebar, add a link WIP: My Pattern Proposal under the Software Design Patterns section.
  2. Click on the newly created link and write down your design pattern proposal. Explain which problem it solves and what the solution is. Include any link which might help understanding this concept. Maybe in the form of a Problem-Statement-&-Solution?
  3. Once your proposal is complete, mark it open for comments/reviews from the team by replacing the prefix WIP: by RFC:. Don't forget to change this in both the page title and your proposal's link in the wiki sidebar under the Software Design Patterns section.
  4. At the top of your proposal's wiki page, add the text Approved by: on a new line. This will be used in the following steps.
  5. Introduce your proposal to the team. Implementing it in a PR is a good starting point to discuss about the changes, teach others and gather feedback.
  6. Address feedback and gather approvals for your proposal from team members by having them add their name at the end of the Approved by: line on your proposal's wiki page.
  7. Once the team reaches an agreement, remove the prefix RFC: both from the page title and your proposal's link under the Software Design Patterns section.
  8. Celebrate and start using this design pattern! 🎉
Clone this wiki locally