2016-01-18 04:53:10 -08:00
|
|
|
# Contributing Guidelines
|
2016-02-18 07:20:19 -08:00
|
|
|
Thank you for your contributing! My requests are few things. Please read below.
|
2016-01-18 04:53:10 -08:00
|
|
|
|
|
|
|
|
## Issue
|
2016-02-18 07:20:19 -08:00
|
|
|
Thank you for feedback. When you report a problem, please pay attention to following points.
|
2016-01-18 04:53:10 -08:00
|
|
|
|
|
|
|
|
### Does it happen on web browsers? (especially Chrome)
|
2016-02-18 07:20:19 -08:00
|
|
|
electron-mattermost is based on Electron. It integrates Chrome as a browser window.
|
|
|
|
|
If the problem appears on web browsers, it may be the issue for Mattermost (or Chrome).
|
|
|
|
|
|
|
|
|
|
### Try "Clear Cache and Reload"
|
|
|
|
|
It's available as `Ctrl(Command) + Shift + R`.
|
|
|
|
|
Some layout problems are caused by browser cache.
|
|
|
|
|
Especially, this kind of issue might happen when you have updated Mattermost server.
|
2016-01-18 04:53:10 -08:00
|
|
|
|
|
|
|
|
### Write detailed information
|
2016-02-18 07:20:19 -08:00
|
|
|
Following points are very helpful to understand the problem.
|
2016-01-18 04:53:10 -08:00
|
|
|
|
2016-02-18 07:20:19 -08:00
|
|
|
* How to reproduce, step-by-step
|
|
|
|
|
* Expected behavior (or what is wrong)
|
|
|
|
|
* Screenshots (for GUI issues)
|
2016-01-18 04:53:10 -08:00
|
|
|
* electron-mattermost version
|
|
|
|
|
* OS
|
|
|
|
|
* Mattermost version
|
|
|
|
|
|
|
|
|
|
## Pull request
|
2016-02-18 07:20:19 -08:00
|
|
|
PR is welcome. Thank you for your great works!
|
2016-01-18 04:53:10 -08:00
|
|
|
|
|
|
|
|
When you edit the code, please run `npm run prettify` before your `git commit`.
|
|
|
|
|
Codes will be formatted.
|
|
|
|
|
|
|
|
|
|
Then, such as following points are helpful.
|
|
|
|
|
|
|
|
|
|
* Tested OS
|
|
|
|
|
* Tested Mattermost version
|
|
|
|
|
* Test codes for your changes
|
