Update CONTRIBUTING.md

This commit is contained in:
Yuya Ochiai 2016-02-19 00:20:19 +09:00
parent 3168135082
commit 9fdf2106b2

View file

@ -1,23 +1,30 @@
# Contributing Guidelines # Contributing Guidelines
Thank you for your contributing! My requirements are few things. Please read them. Thank you for your contributing! My requests are few things. Please read below.
## Issue ## Issue
Thank you for feedback. When you report a problem, please pay attention to fowllowing points. Thank you for feedback. When you report a problem, please pay attention to following points.
### Does it happen on web browsers? (especially Chrome) ### Does it happen on web browsers? (especially Chrome)
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). 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.
### Write detailed information ### Write detailed information
Following points are important to understand the problem. Following points are very helpful to understand the problem.
* How to reproduce, step-by-step
* Expected behavior (or what is wrong)
* Screenshots (for GUI issues)
* electron-mattermost version * electron-mattermost version
* OS * OS
* Mattermost version * Mattermost version
* Expected behavior (or what is wrong)
* How to reproduce, step-by-step
## Pull request ## Pull request
PR is welcome. PR is welcome. Thank you for your great works!
When you edit the code, please run `npm run prettify` before your `git commit`. When you edit the code, please run `npm run prettify` before your `git commit`.
Codes will be formatted. Codes will be formatted.