From 966d4d85ef758af2c8858f6410388d64011d0b84 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Tue, 2 Sep 2014 17:10:05 +0300 Subject: Mention [skip ci] in CONTRIBUTING.md. http://docs.travis-ci.com/user/how-to-skip-a-build/ --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f02ba2216d2..845be6e482b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -62,6 +62,7 @@ If you can, please submit a merge request with the fix or improvements including 1. Create a feature branch 1. Write [tests](README.md#run-the-tests) and code 1. Add your changes to the [CHANGELOG](CHANGELOG) +1. If you are changing the README, some documentation or other things which have no effect on the tests, add `[ci skip]` somewhere in the commit message 1. If you have multiple commits please combine them into one commit by [squashing them](http://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits) 1. Push the commit to your fork 1. Submit a merge request (MR) to the master branch -- cgit v1.2.1 From 5a14213f06856b1b63db1712eb41099f7dd99f8d Mon Sep 17 00:00:00 2001 From: Sytse Sijbrandij Date: Tue, 16 Sep 2014 17:50:33 +0200 Subject: Don't rebase pushed commits. --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 845be6e482b..4c80c8dbb23 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -92,13 +92,13 @@ For examples of feedback on merge requests please look at already [closed merge 1. The change is as small as possible (see the above paragraph for details) 1. Include proper tests and make all tests pass (unless it contains a test exposing a bug in existing code) -1. Can merge without problems (if not please use: `git rebase master`) +1. Initially contains a single commit (please use `git rebase -i` to squash commits) +1. Can merge without problems (if not please merge master, never rebase commits pushed to the remote server) 1. Does not break any existing functionality 1. Fixes one specific issue or implements one specific feature (do not combine things, send separate merge requests if needed) 1. Keeps the GitLab code base clean and well structured 1. Contains functionality we think other users will benefit from too 1. Doesn't add configuration options since they complicate future changes -1. Initially contains a single commit (please use `git rebase -i` to squash commits) 1. Changes after submitting the merge request should be in separate commits (no squashing). You will be asked to squash when the review is over, before merging. 1. It conforms to the following style guides -- cgit v1.2.1 From 8952c5ce2eeeef1013674feedfceb56e77c874d2 Mon Sep 17 00:00:00 2001 From: Sytse Sijbrandij Date: Wed, 17 Sep 2014 11:23:44 +0200 Subject: Highlight the word master when referring to a branch name to make it more obvious, thanks Ben. --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c80c8dbb23..0613fcdf853 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -93,7 +93,7 @@ For examples of feedback on merge requests please look at already [closed merge 1. The change is as small as possible (see the above paragraph for details) 1. Include proper tests and make all tests pass (unless it contains a test exposing a bug in existing code) 1. Initially contains a single commit (please use `git rebase -i` to squash commits) -1. Can merge without problems (if not please merge master, never rebase commits pushed to the remote server) +1. Can merge without problems (if not please merge `master`, never rebase commits pushed to the remote server) 1. Does not break any existing functionality 1. Fixes one specific issue or implements one specific feature (do not combine things, send separate merge requests if needed) 1. Keeps the GitLab code base clean and well structured -- cgit v1.2.1 From eb819c1e4fee9dc26e162657d31da54bb0731c2b Mon Sep 17 00:00:00 2001 From: Ciro Santilli Date: Fri, 19 Sep 2014 13:39:49 +0200 Subject: CONTRIBUTING typos. --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0613fcdf853..3c26b997149 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,7 @@ Please send a merge request with a tested solution or a merge request with a fai 1. **Output of checks** * Results of GitLab [Application Check](doc/install/installation.md#check-application-status) (`sudo -u git -H bundle exec rake gitlab:check RAILS_ENV=production SANITIZE=true`); we will only investigate if the tests are passing * Version of GitLab you are running; we will only investigate issues in the latest stable and development releases as per the [maintenance policy](MAINTENANCE.md) - * Add the last commit sha1 of the GitLab version you used to replicate the issue (obtainable from the help page) + * Add the last commit SHA-1 of the GitLab version you used to replicate the issue (obtainable from the help page) * Describe your setup (use relevant parts from `sudo -u git -H bundle exec rake gitlab:env:info RAILS_ENV=production`) 1. **Possible fixes**: If you can, link to the line of code that might be responsible for the problem @@ -76,7 +76,7 @@ If you can, please submit a merge request with the fix or improvements including The **official merge window** is in the beginning of the month from the 1st to the 7th day of the month. The best time to submit a MR and get feedback fast. Before this time the GitLab B.V. team is still dealing with work that is created by the monthly release such as assisting subscribers with upgrade issues, the release of Enterprise Edition and the upgrade of GitLab Cloud. After the 7th it is already getting closer to the release date of the next version. This means there is less time to fix the issues created by merging large new features. -Please keep the change in a single MR **as small as possible**. If you want to contribute a large feature think very hard what the minimum viable change is. Can you split functionality? Can you only submit the backend/API code? Can you start with a very simple UI? Can you do part of the refactor? The increased reviewability of small MR's that leads to higher code quality is more important to us than having a mimimal commit log. The smaller a MR is the more likely it is it will be merged (quickly), after that you can send more MR's to enhance it. +Please keep the change in a single MR **as small as possible**. If you want to contribute a large feature think very hard what the minimum viable change is. Can you split functionality? Can you only submit the backend/API code? Can you start with a very simple UI? Can you do part of the refactor? The increased reviewability of small MR's that leads to higher code quality is more important to us than having a minimal commit log. The smaller a MR is the more likely it is it will be merged (quickly), after that you can send more MR's to enhance it. For examples of feedback on merge requests please look at already [closed merge requests](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests?assignee_id=&label_name=&milestone_id=&scope=&sort=&state=closed). If you would like quick feedback on your merge request feel free to mention one of the Merge Marshalls of [the core-team](https://about.gitlab.com/core-team/). Please ensure that your merge request meets the following contribution acceptance criteria. @@ -86,7 +86,7 @@ For examples of feedback on merge requests please look at already [closed merge 1. Are there points in the code the reviewer needs to double check? 1. Why was this MR needed? 1. What are the relevant issue numbers / [Feature requests](http://feedback.gitlab.com/)? -1. Screenshots (If appropiate) +1. Screenshots (If appropriate) ## Contribution acceptance criteria @@ -115,4 +115,4 @@ For examples of feedback on merge requests please look at already [closed merge 1. [Shell commands](doc/development/shell_commands.md) created by GitLab contributors to enhance security 1. [Markdown](http://www.cirosantilli.com/markdown-styleguide) -This is also the style used by linting tools such as [Rubocop](https://github.com/bbatsov/rubocop), [PullReview](https://www.pullreview.com/) and [Hound CI](https://houndci.com). +This is also the style used by linting tools such as [RuboCop](https://github.com/bbatsov/rubocop), [PullReview](https://www.pullreview.com/) and [Hound CI](https://houndci.com). -- cgit v1.2.1