MAINTENANCE.md 4.85 KB
Newer Older
1
# Maintainer Guide
2

3
This file outlines the current maintainers of this open source project and
4
expectations. It also includes credits to past maintainers and the project
5
creator.
6

7
## Project Name
8

9
When reference externally, please use this for the short name:
10

11
- Puppet module for Mattermost
12

13
Please use this long name:
14 15 16

- Puppet module for Mattermost by Richard Grainger

17
## Maintainers
18

19
The following people help to maintain this open source project:
20

21 22 23 24
| Name              | GitLab ID                                   | GitHub ID                                   | Start Date   |
|:------------------|:--------------------------------------------|:--------------------------------------------|:-------------|
| Richard Grainger  | [@harbottle](https://gitlab.com/harbottle)  | [@liger1978](https://github.com/liger1978)  | Jan 09 2016  |
| Carlos Panato     | [@cpanato](https://gitlab.com/cpanato)      | [@cpanato](https://github.com/cpanato)      | Aug 30 2017  |
25 26 27

In case something happens where no maintainers are able to complete their
responsibilies, the following sponsoring organization can help find a new
28
maintainer:
29

30 31 32
| Sponsoring Organization                                         | Start Date    |
|:----------------------------------------------------------------|:--------------|
| [Mattermost Open Source Project](https://github.com/mattermost) | Mar 06 2017   |
33 34 35 36 37

## Activities

The following is a guide for current, new maintainers and prospective
maintainers of this open source project to get started and to understand
38
on-going responsibilities:
39

40
### Getting Started
41

42
The following steps should be completed by a new maintainer
43 44

1. **Add your name** - Create a pull request to add your name, GitHub username
45
and start date to this document.
46 47 48 49 50
2. **Subscribe to mailing lists** - To be notified of new releases and security
updates of Mattermost, subscribe to the
[Mattermost Security Update Mailing List](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=3a93eb6929) and the
[Mattermost Insiders Newsletter](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=2add1c8034)

51
### Updating
52 53 54

When receiving a mailing list email about a new security update or major version
of Mattermost being released, the maintainer should update the version number of
55
this project by doing the following:
56 57 58 59

1) In the **master branch**

- Change the version number to the latest release in:
harbottle's avatar
harbottle committed
60 61 62 63
  * `metadata.json`
  * `CHANGELOG`
  * `README.md`
  * `manifests/params.pp`
64 65 66

2) Release a new forge module.

67
### Issue and Pull Request Review
68

69
Maintainers should periodically review pull requests and issues submitted to provide feedback and to merge pull request changes when the maintainer feels the change would be appropriate.
70

71
## Credits
72

73
### Creator
74

75 76 77
| Name              | GitLab ID                                   | GitHub ID                                   | Created Date |
|:------------------|:--------------------------------------------|:--------------------------------------------|:-------------|
| Richard Grainger  | [@harbottle](https://gitlab.com/harbottle)  | [@liger1978](https://github.com/liger1978)  | Jan 09 2016  |
78

79
### Contributors
80

harbottle's avatar
harbottle committed
81 82 83 84 85 86 87 88 89 90 91
| Name                     | GitLab ID                                                  | GitHub ID                                             |
|:-------------------------|:-----------------------------------------------------------|:------------------------------------------------------|
| Carles Amigó             | [@fr3nd](https://gitlab.com/fr3nd)                         | [@fr3nd](https://github.com/fr3nd)                    |
| Jeoffrey Bauvin          | [@JeoffreyB](https://gitlab.com/JeoffreyB)                 | [@Jeoffreybauvin](https://github.com/Jeoffreybauvin)  |
| Francesco Canovai        | [@francesco.canovai](https://gitlab.com/francesco.canovai) | [@fcanovai](https://github.com/fcanovai)              |
| Richard Grainger         | [@harbottle](https://gitlab.com/harbottle)                 | [@liger1978](https://github.com/liger1978)            |
| Garrett Guillotte        | [@oznogon](https://gitlab.com/oznogon)                     | [@gguillotte](https://github.com/gguillotte)          |
| Christopher Jenkins      | [@christj](https://gitlab.com/christj)                     | [@sevendials](https://github.com/sevendials)          |
| Martin Krebs             | [@mtkr](https://gitlab.com/mtkr)                           | [@posteingang](https://github.com/posteingang)        |
| Marco Nenciarini         | [@mnencia](https://gitlab.com/mnencia)                     | [@mnencia](https://github.com/mnencia)                |
| Carlos Panato            | [@cpanato](https://gitlab.com/cpanato)                     | [@cpanato](https://github.com/cpanato)                |
harbottle's avatar
harbottle committed
92
| Louis-Philippe Véronneau | [@baldurmen](https://gitlab.com/baldurmen)                 | [@baldurmen](https://github.com/baldurmen)            |