diff options
Diffstat (limited to 'doc/developer')
-rw-r--r-- | doc/developer/Code-Contribution-Guidelines.md | 6 | ||||
-rw-r--r-- | doc/developer/Setup.md | 4 |
2 files changed, 6 insertions, 4 deletions
diff --git a/doc/developer/Code-Contribution-Guidelines.md b/doc/developer/Code-Contribution-Guidelines.md index 80676f107..453c154f9 100644 --- a/doc/developer/Code-Contribution-Guidelines.md +++ b/doc/developer/Code-Contribution-Guidelines.md @@ -5,7 +5,6 @@ Thank you for your interest in contributing to Mattermost. This guide provides a ## Choose a Ticket 1. Review the list of [Good First Contribution](https://mattermost.atlassian.net/issues/?filter=10206) tickets listed in Jira. - 2. These projects are intended to be a straight forward first pull requests from new contributors. If you don't find something appropriate for your interests, please see the full list of tickets [Accepting Pull Requests](https://mattermost.atlassian.net/issues/?filter=10101). @@ -13,7 +12,7 @@ If you don't find something appropriate for your interests, please see the full ## Install Mattermost and set up a Fork -1. Follow [developer setup instructions](https://github.com/mattermost/platform/blob/master/doc/install/dev-setup.md) to install Mattermost. +1. Follow [developer setup instructions](https://github.com/mattermost/platform/blob/master/doc/developer/Setup.md) to install Mattermost. 2. Create a branch with <branch name> set to the ID of the ticket you're working on, for example ```PLT-394```, using command: @@ -29,6 +28,9 @@ git checkout -b <branch name> 2. Please make sure to thoroughly test your change before submitting a pull request. + Please review the ["Fast, Obvious, Forgiving" experience design principles](http://www.mattermost.org/design-principles/) for Mattermost and check that your feature meets the criteria. Also, for any changes to user interface or help text, please read the changes out loud, as a quick and easy way to catch any inconsitencies. + + ## Submitting a Pull Request 1. Please add yourself to the Mattermost [approved contributor list](https://docs.google.com/spreadsheets/d/1NTCeG-iL_VS9bFqtmHSfwETo5f-8MQ7oMDE5IUYJi_Y/pubhtml?gid=0&single=true) prior to submitting by completing the [contributor license agreement](http://www.mattermost.org/mattermost-contributor-agreement/). diff --git a/doc/developer/Setup.md b/doc/developer/Setup.md index c63bde512..afaef4ee4 100644 --- a/doc/developer/Setup.md +++ b/doc/developer/Setup.md @@ -11,7 +11,7 @@ Developer Machine Setup `docker-machine ip dev` 3. Add a line to your /etc/hosts that goes `<Docker IP> dockerhost` 4. Run `docker-machine env dev` and copy the export statements to your ~/.bash_profile -2. Download Go (version 1.4.2) from http://golang.org/dl/ +2. Download Go (version 1.4.2 or 1.5.1. Final release bits are built with 1.4.2) from http://golang.org/dl/ 3. Set up your Go workspace 1. `mkdir ~/go` 2. Add the following to your ~/.bash_profile @@ -51,7 +51,7 @@ Any issues? Please let us know on our forums at: http://forum.mattermost.org `127.0.0.1 dockerhost` 3. Install build essentials 1. `apt-get install build-essential` -4. Download Go (version 1.4.2) from http://golang.org/dl/ +4. Download Go (version 1.4.2 or 1.5.1. Final release bits are built with 1.4.2) from http://golang.org/dl/ 5. Set up your Go workspace and add Go to the PATH 1. `mkdir ~/go` 2. Add the following to your ~/.bashrc |