search

sky-uk / csp-tech-radar

The Sky Plc Content Supply Platforms department technology radar.
Creative Commons Attribution Share Alike 4.0 International
6 stars 4 forks source link

Revised contributing guidelines to be issue driven #45

Closed pburls closed 3 years ago

pburls commented 3 years ago

This PR attempts to up the contributing guidance to clearly show a proposal process that revolves around creating Issues before raising Pull Requests. This is more similar to the process most open source projects tend to encourage. The following changes have been made:

  1. Created a contributing-process.plantuml file to capture the contribution/proposal process as a flow diagram.
  2. Updated CONTRIBUTING.md to reflect the contribution steps and include a rendered version of the flow diagram.
  3. Created a new Issue template.
  4. Updated the PR template.
pburls commented 3 years ago

Here is a link to the rendered version of the CONTRIBUTING.md file: https://github.com/sky-uk/csp-tech-radar/blob/revised-contributing-guidelines/CONTRIBUTING.md

RichEmersonSky commented 3 years ago

There is a typo in contributing-process.png on Issue Closed block

pburls commented 3 years ago

There is a typo in contributing-process.png on Issue Closed block

@RichEmersonSky Good spot!