mattermost-desktop/CONTRIBUTING.md

40 lines
1.8 KiB
Markdown
Raw Normal View History

2016-01-18 04:53:10 -08:00
# Contributing Guidelines
2018-05-18 22:34:49 -07:00
Thank you for your interest in contributing! Please see the guidelines below before contributing. and [join our "Desktop App" community channel](https://pre-release.mattermost.com/core/channels/desktop-app) to ask questions from community members and the Mattermost core team.
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)
Mattermost Desktop is based on Electron, which integrates the Chrome engine within a standalone application.
If the problem you encounter can be reproduced on web browsers, it may be an issue with Mattermost server (or Chrome).
2016-02-18 07:20:19 -08:00
### 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-03-22 07:37:59 -07:00
Detailed information is very helpful to understand the problem.
2016-01-18 04:53:10 -08:00
2016-03-22 07:37:59 -07:00
For example:
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-03-15 04:44:26 -07:00
* Application version
* Operating system
2016-03-22 07:37:59 -07:00
* Mattermost server version
2016-01-18 04:53:10 -08:00
2016-03-11 07:22:06 -08:00
## Feature idea
Please see http://www.mattermost.org/feature-requests/ .
2016-01-18 04:53:10 -08:00
## Pull request
Pull requests are welcome. Thank you for your great work!
2016-01-18 04:53:10 -08:00
2016-10-27 08:47:36 -07:00
1. When you edit the code, please confirm `npm test` successfully finishes.
2. Please update `CHANGELOG.md` and `docs/*.md` if it's necessary.
3. In the description of your pull request, please include:
2016-03-22 07:37:59 -07:00
* Operating System version on which you tested
* Mattermost server version on which you tested
* New or updated unit tests for your changes
4. Please complete the [Mattermost CLA](http://www.mattermost.org/mattermost-contributor-agreement/) prior to submitting a PR.