diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/README.md | 5 | ||||
| -rw-r--r-- | doc/developer/code-contribution.md | 44 | ||||
| -rw-r--r-- | doc/install/dev-setup.md | 12 |
3 files changed, 53 insertions, 8 deletions
diff --git a/doc/README.md b/doc/README.md index 36d16b744..491c75b9b 100644 --- a/doc/README.md +++ b/doc/README.md @@ -16,9 +16,10 @@ ### Configuration - [GitLab SSO Configuration](integrations/sso/gitlab-sso.md) -- [SMTP Email Setup](smtp-email-setup.md) +- [SMTP Email Setup](config/smtp-email-setup.md) ## Developer Documentation -- [Developer Machine Setup](doc/install/dev-setup.md) +- [Code Contribution Guidelines](developer/code-contribution.md) +- [Developer Machine Setup](install/dev-setup.md) - [Mattermost Style Guide](developer/style-guide.md) diff --git a/doc/developer/code-contribution.md b/doc/developer/code-contribution.md new file mode 100644 index 000000000..1a6537287 --- /dev/null +++ b/doc/developer/code-contribution.md @@ -0,0 +1,44 @@ +# Code Contribution Guidelines + +Thank you for your interest in contributing to Mattermost. This guide provides an overview of important information for contributors to know. + +## 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). + +3. If you have any questions at all about a ticket, please post to the [Contributor Discussion section](http://forum.mattermost.org/) of the Mattermost forum, or email the [Mattermost Developer Mailing list](https://groups.google.com/a/mattermost.com/forum/#!forum/developer/join). + +## 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. + +2. Create a branch with <branch name> set to the ID of the ticket you're working on, for example ```PLT-394```, using command: + +``` +git checkout -b <branch name> +``` + +## Programming and Testing + +1. Please review the [Mattermost Style Guide](developer/style-guide.md) prior to making changes. + +2. Please make sure to thoroughly test your change before submitting a pull request. + +## Submitting a Pull Request + +1. Please add yourself to the contributor list prior to submitting by completing the [contributor license agreement](http://www.mattermost.org/mattermost-contributor-agreement/). + +2. When you submit your pull request please include the Ticket ID at the beginning of your pull request comment, followed by a colon. + + For example, for a ticket ID `PLT-394` start your comment with: `PLT-394:`. See [previously closed pull requests](https://github.com/mattermost/platform/pulls?q=is%3Apr+is%3Aclosed) for examples. + +3. Once submitted, your pull request will be checked via an automated build process and will be reviewed by the Mattermost core team, who may either accept the PR or follow-up with feedback. + +4. If you've included your mailing address in Step 1, you'll be receiving a [Limited Edition Mattermost Mug](http://forum.mattermost.org/t/limited-edition-mattermost-mugs/143) as a thank you gift after your first pull request has been accepted. + + + + diff --git a/doc/install/dev-setup.md b/doc/install/dev-setup.md index a088bbbc2..b90b6a351 100644 --- a/doc/install/dev-setup.md +++ b/doc/install/dev-setup.md @@ -10,7 +10,7 @@ Developer Machine Setup 2. Get your Docker IP address with `boot2docker ip` 3. Add a line to your /etc/hosts that goes `<Docker IP> dockerhost` 4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash_profile -2. Download Go from http://golang.org/dl/ +2. Download Go (version 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 @@ -22,13 +22,13 @@ Developer Machine Setup 1. Download Homebrew from http://brew.sh/ 2. `brew install node` 5. Install Compass - 1. Make sure you have the latest verison of Ruby - 2. `gem install compass` + 1. Run `ruby -v` and check the ruby version is 1.8.7 or higher + 2. `sudo gem install compass` 6. Download Mattermost `cd ~/go` `mkdir -p src/github.com/mattermost` `cd src/github.com/mattermost` - `git clone github.com/mattermost/platform.git` + `git clone https://github.com/mattermost/platform.git` `cd platform` 7. Run unit tests on Mattermost using `make test` to make sure the installation was successful 8. If tests passed, you can now run Mattermost using `make run` @@ -50,7 +50,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 from http://golang.org/dl/ +4. Download Go (version 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 @@ -74,7 +74,7 @@ Any issues? Please let us know on our forums at: http://forum.mattermost.org `cd ~/go` `mkdir -p src/github.com/mattermost` `cd src/github.com/mattermost` - `git clone github.com/mattermost/platform.git` + `git clone https://github.com/mattermost/platform.git` `cd platform` 9. Run unit tests on Mattermost using `make test` to make sure the installation was successful 10. If tests passed, you can now run Mattermost using `make run` |