Update CONTRIBUTING.md

This commit is contained in:
Yuya Ochiai
2016-03-22 23:37:59 +09:00
parent ab18e33f7f
commit adc1ebe875

View File

@@ -5,8 +5,8 @@ Thank you for your contributing! My requests are few things. Please read below.
Thank you for feedback. When you report a problem, please pay attention to following 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. Mattermost Desktop 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). If the problem appears on web browsers, it may be the issue for Mattermost server (or Chrome).
### Try "Clear Cache and Reload" ### Try "Clear Cache and Reload"
It's available as `Ctrl(Command) + Shift + R`. It's available as `Ctrl(Command) + Shift + R`.
@@ -14,14 +14,15 @@ Some layout problems are caused by browser cache.
Especially, this kind of issue might happen when you have updated Mattermost server. Especially, this kind of issue might happen when you have updated Mattermost server.
### Write detailed information ### Write detailed information
Following points are very helpful to understand the problem. Detailed information is very helpful to understand the problem.
For example:
* How to reproduce, step-by-step * How to reproduce, step-by-step
* Expected behavior (or what is wrong) * Expected behavior (or what is wrong)
* Screenshots (for GUI issues) * Screenshots (for GUI issues)
* Application version * Application version
* Operating system * Operating system
* Mattermost version * Mattermost server version
## Feature idea ## Feature idea
Please see http://www.mattermost.org/feature-requests/ . Please see http://www.mattermost.org/feature-requests/ .
@@ -29,10 +30,9 @@ Please see http://www.mattermost.org/feature-requests/ .
## Pull request ## Pull request
Pull requests are welcome. Thank you for your great work! Pull requests are welcome. Thank you for your great work!
1. When you edit the code, please run `npm run prettify` to format your code before `git commit`. 1. When you edit the code, please run `npm run prettify` to format your code before `git commit`.
2. In the description of your pull request, please include: 2. In the description of your pull request, please include:
* Operating System version on which you tested * Operating System version on which you tested
* Mattermost server version on which you tested * Mattermost server version on which you tested
* New or updated unit tests for your changes * New or updated unit tests for your changes
3. Please complete the [Mattermost CLA](http://www.mattermost.org/mattermost-contributor-agreement/) prior to submitting a PR. 3. Please complete the [Mattermost CLA](http://www.mattermost.org/mattermost-contributor-agreement/) prior to submitting a PR.