Contribution Guide

How you can help out the Pragmatic Penguin Pattern Portfolio

How to contribute

Thank you for taking the time to see how you can help out our project. We could use your help!

Even if you are not a automation expert, you can provide meaningful input to the project. We are appreciative of anyone willing to donate some of their time by giving user feedback, testing the information or techniques mentioned, or providing your own experiences and input.

How can I help?

The source code of this project is open source, and we welcome contributions from the community. You can find the source code on GitHub. From there, you can:

Ideas and Bug hunting

Bug Reporting

This section guides you through submitting a bug report for the Pattern Portfolio. Following these guidelines helps maintainers and the community understand your report, reproduce the behaviour, and find related reports.

Before creating bug reports, please Check the list of open issues as you might find out that you don’t need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Proposing Patterns and Ideas

If you have a pattern (micro strategy / technique) to add, please feel free to create a ticket on the issue tracker. In order to submit a pattern, kindly use the provided template. You can select this template when you create a new issue ticket. The relevant fields will be provided, and a short outline is given of which content is expected in the different sections. If you include any images in your information, kindly add them as an attachment to the ticket you are creating.

Code Contribution Guidelines

If you would like to contribute code, or write patterns, please follow these steps:

  1. Fork the repository
  2. Create a new branch, and work on it
  3. When your change is DONE (implemented, and tested), submit a Pull Request.
  4. After the review process is completed, your changes will be merged into our develop branch. It will get deployed automatically to the public preview website.

Running and building the project locally

Installation

  • Install the HuGo static site generator: see the official guide
  • Use hugo server to spawn a local webserver that dynamically updates to inspect your changes

When your changes are done, launch a Pull Request towards the develop branch of the base repository.

Submitting Changes

Whether you are contributing to the source code, or want to add your example files (including themes) to the repository, please follow these steps:

  • Create a new branch, and work on it
  • When your change is DONE (implemented, and tested), submit a Pull Request using our existing PR Templates
  • After the review process is completed, your changes will be merged into our develop branch and automatically deployed to the public preview website.