From 8f95e9f1c7daad680f9879cb95aaba13d182fbef Mon Sep 17 00:00:00 2001 From: Pete Peterson <peterfpeterson@gmail.com> Date: Tue, 3 Feb 2015 12:37:23 +0000 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3665844e4a6..3bcd9426029 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,13 @@ -The [developer documentation](http://www.mantidproject.org/Category:Development) has information on how to participate in the mantid project as a developer. This document is meant to outline the steps for contributing to mantid without becomming a developer. +The [developer documentation](http://www.mantidproject.org/Category:Development) has information on how to participate in the mantid project as a developer. This document is meant to outline the steps for contributing to mantid without becomming a developer. We aspire to have similar guidelines as [github](https://github.com/blog/1943-how-to-write-the-perfect-pull-request). 1. [Fork](https://help.github.com/articles/fork-a-repo) the repository. 2. Make changes as you see fit. Please still follow the guidelines for [running the unit tests](http://www.mantidproject.org/Running_the_unit_tests) and the [build servers](http://www.mantidproject.org/The_automated_build_process). - 3. Before submitting pull requests email mantid-help@mantidproject.org, and a developer will set up a branch that you can submit pull requests to. - 4. Submit a [pull request](https://help.github.com/articles/using-pull-requests) to this branch. + 3. (Optional) email mantid-help@mantidproject.org, and a developer will set up a branch that you can submit pull requests to. + 4. Submit a [pull request](https://help.github.com/articles/using-pull-requests) to this branch. This is a start to the conversation. - -Hints to make the integration of your changes easy: +Hints to make the integration of your changes easy (and happen faster): - Keep your pull requests small +- Some comments are part of the build server infrastructure (e.g. 'test this please') - Don't forget your unit tests - All algorithms need documentation, don't forget the .rst file -- Contact us before creating the pull request - Don't take changes requests to change your code personally -- GitLab