Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Add contribution guidelines to PMM GitHub - intro/explain on folders/repo, review, PRs, FB

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 below) CONTRIBUTING.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. Explain folder and repo structure of all components that are needed to get a PMM development environment up and running

    1. Folders -  TBD

    2. Repos - done

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

Activity

Denys Kondratenko December 30, 2022 at 10:48 AM

Jira Bot January 29, 2021 at 1:56 PM

To:
CC:

Hi, I'm jira-bot, Percona's Jira automation tool. I've detected that someone from
Percona has made an edit to the Summary field of an issue that you reported.

I'm not sentient (yet) so I'm not sure whether the person fixed a typo, changed
a few words, or completely rewrote the text. In any case, it is Percona Engineering's
intention to make the Summary and Description of an issue as accurate as possible
so that we're fixing the actual problem you're encountering, and to avoid
misunderstandings about symptoms and causes.

If the current Summary does not accurately reflect the problem you are reporting,
or if you feel the change was otherwise inappropriate in some way, please add a
new comment explaining things and we'll address it as soon as we can.

This message will be added only once per issue, regardless of how many times
the Summary is edited.

message-code:summary-edited

Done

Details

Assignee

Reporter

Priority

Components

Labels

Needs Doc

Story Points

Parent

Created January 25, 2021 at 2:07 PM
Updated March 6, 2024 at 3:18 AM
Resolved December 30, 2022 at 10:48 AM