This repository has been archived on 2021-08-31. You can view files and clone it, but cannot push or open issues or pull requests.
mattermost/MAINTENANCE.md

71 lines
2.8 KiB
Markdown
Raw Permalink Normal View History

2018-08-24 14:35:01 +02:00
# Maintainer Guide
2018-08-24 14:35:01 +02:00
This file outlines the current maintainer(s) of this open source project and expectations. It also includes credits to past maintainers and the project creator.
2018-08-24 14:35:01 +02:00
## Project Name
2018-08-24 14:35:01 +02:00
When reference externally, please use this for the short name:
2017-02-04 07:09:24 +01:00
2018-08-24 14:35:01 +02:00
- Production Docker deployment for Mattermost
2017-02-04 07:09:24 +01:00
2018-08-24 14:35:01 +02:00
Please use this long name:
2017-02-04 05:56:53 +01:00
2017-02-04 07:08:11 +01:00
- Production Docker deployment for Mattermost by the Mattermost open source project
2017-02-04 05:56:53 +01:00
## Maintainer(s)
2018-08-24 14:35:01 +02:00
The following people help to maintain this open source project:
2019-02-21 20:27:52 +01:00
| Current Maintainer(s) | Start Date |
|:--------------------------------------|:--------------|
| Carlos Tadeu Panato Junior - @cpanato | Feb 18 2018 |
In case something happens where no maintainers are able to complete their responsibilities, the following sponsoring organization can help find a new maintainer:
2018-08-24 14:35:01 +02:00
| Sponsoring Organization | Start Date |
|:-------------------------------|:--------------|
2017-02-04 07:54:14 +01:00
| Mattermost Open Source Project | Dec 04 2016 |
2017-02-04 06:42:44 +01:00
## Activities
2017-02-04 05:56:53 +01:00
2018-08-24 14:35:01 +02:00
The following is a guide for current, new maintainers and prospective maintainers of this open source project to get started and to understand on-going responsibilities:
2017-02-04 05:56:53 +01:00
2018-08-24 14:35:01 +02:00
### Getting Started
2018-08-24 14:35:01 +02:00
The following steps should be completed by a new maintainer
2017-02-04 05:56:53 +01:00
2018-08-24 14:35:01 +02:00
1. **Add your name** - Create a pull request to add your name, GitHub username and start date to this document.
2017-02-04 07:46:32 +01:00
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)
2018-08-24 14:35:01 +02:00
### Updating
2018-08-24 14:35:01 +02:00
When receive a mailing list email about a new security update or major version of Mattermost being released, update the version number of this project by doing the following:
2017-02-04 05:56:53 +01:00
2018-01-09 22:37:46 +01:00
In the **master branch**
2017-02-04 07:46:32 +01:00
2018-08-24 14:35:01 +02:00
- Change the [version number](https://github.com/mattermost/mattermost-docker/blob/master/app/Dockerfile#L6) to the latest release
- Tag the repo
2017-02-04 07:46:32 +01:00
2018-08-24 14:35:01 +02:00
### Issue and Pull Request Review
2017-02-04 06:01:22 +01:00
2018-08-24 14:35:01 +02:00
Maintainer(s) 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.
2017-02-04 06:01:22 +01:00
2018-08-24 14:35:01 +02:00
## Credits
2018-08-24 14:35:01 +02:00
PREVIOUS MAINTAINERS
| Maintainer | Start Date | End Date |
|:------------------------|:--------------|:------------|
| Yi EungJun - @npcode | Nov 26 2015 | Nov 30 2016 |
| Pan Luo - @xcompass | Nov 30 2015 | Feb 21 2019 |
| Kyâne Pichou - @pichouk | Jun 01 2017 | Aug 15 2019 |
2018-08-24 14:35:01 +02:00
CREATOR
| Creator | Created Date |
|:-----------------------|:--------------|
2017-02-04 07:54:14 +01:00
| Yi EungJun - @npcode | Nov 26 2015 |