Add contribution guidelines to PMM GitHub - Build and Run Test

Description

We have external contributors who need documentation on how to get started with developing with PMM. This ticket is about technical instructions, unless you want to add more background information.

 

Minimum DoD in order of importance

A (useful -> see list belowCONTRIBUTING.md exists somewhere in a main PMM-related repo (https://github.com/percona/pmm/tree/PMM-2.0 ) and can be linked to from other PMM-repos  

  1. Quick start explanation of a code contribution and the steps it will go through on our side

    1. build: https://confluence.percona.com/display/PMM/Feature+Builds+-+Technical+design#FeatureBuildsTechnicaldesign-How-tobuildfeaturebranchlocally  ?

  2. Explanation of how to test a contribution locally

    1. TBD

Additional information

Example CONTRIBUTING.md: https://github.com/atom/atom/blob/master/CONTRIBUTING.md

GitHub docs: https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors

More information: http://mozillascience.github.io/working-open-workshop/contributing/ 

How to test

None

How to document

None

Smart Checklist

Activity

Denys Kondratenko May 6, 2022 at 4:49 PM

Done

Details

Assignee

Reporter

Priority

Components

Story Points

Due date

Smart Checklist

Created January 27, 2021 at 12:30 PM
Updated March 6, 2024 at 3:16 AM
Resolved May 6, 2022 at 4:49 PM