[MM-40632] Updates to the Developer Documentation and README, remove unnecessary files and code (#1922)
* [MM-40632] Updates to the Developer Documentation and README, remove unnecessary files and code * Update CONTRIBUTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update README.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update README.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update TESTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update TESTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update TESTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update TESTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update TESTING.md Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Guillermo Vayá <guivaya@gmail.com> * Update TESTING.md Co-authored-by: Guillermo Vayá <guivaya@gmail.com> * PR feedback Co-authored-by: Carrie Warner (Mattermost) <74422101+cwarnermm@users.noreply.github.com> Co-authored-by: Guillermo Vayá <guivaya@gmail.com>
This commit is contained in:
Devin Binnie
@@ -1,39 +1,46 @@
|
||||
# Contributing Guidelines
|
||||
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.
|
||||
Thank you for your interest in contributing! Please see the guidelines below before contributing and [join our "Developers: Desktop App" community channel](https://community.mattermost.com/core/channels/desktop-app) to ask questions from community members and the Mattermost Desktop team.
|
||||
|
||||
You can also visit our [developer guide](https://developers.mattermost.com/contribute/desktop/) to learn more information about how to set up your environment, as well as develop and test changes to the Desktop App.
|
||||
|
||||
## Issue
|
||||
Thank you for feedback. When you report a problem, please pay attention to following points.
|
||||
We really appreciate your feedback on the Desktop App. We'd ask that before you file an issue that you go through a few steps beforehand.
|
||||
|
||||
### Does it happen on web browsers? (especially Chrome)
|
||||
### Does it reproduce in a web browser?
|
||||
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).
|
||||
|
||||
If this is the case, please create an issue in the [mattermost-server](https://github.com/mattermost/mattermost-server) or [mattermost-webapp](https://github.com/mattermost/mattermost-webapp) repositories.
|
||||
|
||||
### 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.
|
||||
Sometimes issues can be resolved simply by refreshing your Mattermost server within the app.
|
||||
You can do this by pressing `CMD/CTRL+SHIFT+R` in the Mattermost Desktop App, or you can go to the menu and select **View > Clear Cache and Reload**.
|
||||
|
||||
### Write detailed information
|
||||
Detailed information is very helpful to understand the problem.
|
||||
|
||||
For example:
|
||||
If the issue still persists, please provide detailed information to help us to understand the problem. Include information such as:
|
||||
* How to reproduce, step-by-step
|
||||
* Expected behavior (or what is wrong)
|
||||
* Screenshots (for GUI issues)
|
||||
* Application version
|
||||
* Operating system
|
||||
* Mattermost server version
|
||||
* Desktop App version (can be viewed by going to 3-dot menu > Help, or **Menu > Mattermost > About Mattermost** on macOS).
|
||||
* Operating System
|
||||
* Mattermost Server version
|
||||
|
||||
## Feature idea
|
||||
Please see http://www.mattermost.org/feature-requests/ .
|
||||
If you have an idea for a new feature, we'd love to hear about it!
|
||||
Please let us know in the Mattermost Community server by making a post in the [Feature Proposals](https://community-daily.mattermost.com/core/channels/feature-ideas) channel.
|
||||
|
||||
## Pull request
|
||||
Pull requests are welcome. Thank you for your great work!
|
||||
If you are interested on working on an issue, we would very much appreciate your help!
|
||||
|
||||
1. When you edit the code, please confirm `npm test` successfully finishes.
|
||||
2. Please update `docs/*.md` if it's necessary.
|
||||
3. In the description of your pull request, please include:
|
||||
* 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.
|
||||
We have a list of issues marked as [Help Wanted](https://mattermost.com/pl/help-wanted-desktop) that are available to be worked on.
|
||||
If you'd like to take on an issue, simply comment on the issue and one of the Core Contributors will assign it to you.
|
||||
|
||||
Once your change is ready, please make sure you perform the following tasks before submitting a pull request:
|
||||
1. Make sure that the PR passes all automated checks. You can do this by running the following commands:
|
||||
```
|
||||
npm run lint:js
|
||||
npm run check-types
|
||||
npm run test
|
||||
```
|
||||
2. If you are fixing a bug, consider writing a unit test for the change so that the issue does not resurface. If you are adding a new feature, consider additionally writing end-to-end (E2E) tests to thoroughly test the changes.
|
||||
3. Please complete the [Mattermost CLA](http://www.mattermost.org/mattermost-contributor-agreement/) prior to submitting a PR.
|
||||
|
||||
Reference in New Issue
Block a user