Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

71 lines (48 loc) · 2.69 KB

Contributing to Cloud Native Patterns

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the patterns
  • Submitting a fix
  • Proposing new patterns
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the patterns. We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added a pattern, double check for typos
  3. If you've changed a pattern, explain your changes with a comment in the PR
  4. Make sure your patterns are following the structure of the pattern
  5. Issue that pull request!

Any contributions you make will be under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License

In short, when you submit pattern changes, your submissions are understood to be under the same CC 4.0 License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue.

Write issue reports with detail, background and explanation

Great Issue Reports tend to have:

  • A quick summary and/or background
  • What you expected should be included in the pattern
  • Notes (possibly including why you think this might be needed)

Use a Consistent Pattern Layout

The pattern should use the following layout:

---
title: <name of the pattern>
description: <1 line summary of pattern>
layout: pattern
---

![<diagram of the pattern>]({{ site.baseurl }}/assets/images/generic.png <link to image if relevant>) 

<A brief description of the context describing the parties involved as “you” or “an organisation”>

## In This Context

<A brief description of the problems and issues that can be found in this context>

## Therefore

<A description of the pattern that is the solution to the problems outlined before and the steps required to adopt that pattern>

## Consequently

<A brief summary outlining the benefits of the pattern.>

<A list of the positives and negatives of this approach grouped by effect>
{:.plusminus}
- {:.plus} <positive effect>
- {:.minus} <negative effect>

License

By contributing, you agree that your contributions will be licensed under its CC 4.0