Commit Graph

169 Commits

Author SHA1 Message Date
Robert Speicher 9f7a7115a4 Convert CHANGELOG to Markdown
All this does is convert the version sections into headers. The list
items shouldn't really be indented by two spaces, but it makes no
difference to the rendering and this way we retain authorship history
for the actual changes.

Related to https://gitlab.com/gitlab-org/release-tools/merge_requests/29
2016-10-16 21:05:24 +02:00
Rémy Coutable 2f7e28d1f7
Improve the contribution and MR review guide
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-10-07 15:28:15 +02:00
Achilleas Pipinellis 7ac475164f Merge branch 'sh-add-link-to-reliable-capybara-specs' into 'master'
Add link to article on how to write reliable, asynchronous tests with Capybara

This article has been incredibly useful for all developers. Adding a link to it so more people can refer to it.

See merge request !6312
2016-09-16 09:46:07 +00:00
Stan Hu dbe37d2f6b Add link to article on how to write reliable, asynchronous tests with Capybara
[ci skip]
2016-09-12 12:37:29 -07:00
Rémy Coutable 4ed7ffd385
Simplify the 'Implement design & UI elements' section in CONTRIBUTING
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-09-07 17:18:39 +02:00
Achilleas Pipinellis ee61c4037e Merge branch 'mr-performance-guides' into 'master'
Added performance guidelines for new MRs

## What does this MR do?

This MR adds a set of guides that should be followed by merge request authors.

## Are there points in the code the reviewer needs to double check?

Spelling, grammar, etc

## Why was this MR needed?

There is no set of guidelines one should follow when submitting merge requests. This leads to developers at times disregarding performance. This in turn results in performance specialists having to clean up the mess, or production engineers being woken up in the middle of the night because the database is on fire.

## Does this MR meet the acceptance criteria?

- [x] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md)
- Tests
  - [x] All builds are passing
- [x] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides)
- [x] Branch has no merge conflicts with `master` (if you do - rebase it please)
- [x] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits)

cc @DouweM @rspeicher @pcarranza @dzaporozhets 

See merge request !5905
2016-08-31 12:51:36 +00:00
Mark Fletcher 7a83df749e Link to the issue templates in Contributing guide
Change to use a better title style

Add backticks to code segments

Spelling and Grammar
2016-08-25 15:48:08 +01:00
Mark Fletcher b1add60648 Reflect template addition in the contributing guide
Adjust bug template to adhere to standard bug report format

* https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines
* Guidelines use the following format

- Summary
- Steps to Reproduce
- Expected Behaviour
- Actual Behaviour
2016-08-24 15:00:33 +01:00
Yorick Peterse e4e03d946e
Added performance guidelines for new MRs
These guidelines cover the performance requirement for newly submitted
merge requests. These guidelines are put in to place to prevent merge
requests from negatively impacting GitLab performance as much as
possible.
2016-08-22 14:32:25 +02:00
Dmitriy Zaporozhets b99f841197 Update contribution acceptance criteria with tests requirements 2016-08-19 09:24:51 +00:00
Dmitriy Zaporozhets 15bbab880e Add test requirement for new files 2016-08-15 15:43:04 +00:00
Robert Speicher fa95d9e48b Merge branch 'dz-newlines-styleguide' into 'master'
Add newlines styleguide for Ruby code 

See merge request !5636
2016-08-08 23:29:56 +00:00
Timothy Andrew c78640890c Add migration-related tips to the "Merge Request Guidelines" doc
[ci-skip]
2016-08-08 08:43:19 +05:30
Dmitriy Zaporozhets 13cabe7184 Add newlines styleguide for Ruby code 2016-08-05 12:19:19 +03:00
Rémy Coutable f4c79d6a84 Merge branch 'coffescript_docs_migration' into 'master'
Update docs for CoffeeScript -> JavaScript.

## What does this MR do?
Removes some CoffeeScript docs and adds more JS ones

## Are there points in the code the reviewer needs to double check?
No

## Why was this MR needed?
To migrate some docs

## What are the relevant issue numbers?
#20098

## Screenshots (if relevant)
None

## Does this MR meet the acceptance criteria?

- [x] [CHANGELOG](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CHANGELOG) entry added
- [x] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md)
- [ ] API support added
- Tests
  - [ ] Added for this feature/bug
  - [ ] All builds are passing
- [x] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides)
- [x] Branch has no merge conflicts with `master` (if you do - rebase it please)
- [x] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits)

See merge request !5433
2016-08-04 11:41:52 +00:00
Job van der Voort 09257ce34c link the engineering workflow document from process and contributing 2016-08-02 13:40:41 +01:00
Jacob Schatz d6ebd4a3f7 Update docs for CoffeeScript -> JavaScript. 2016-07-22 20:13:46 -07:00
Mark Pundsack 81a34f2f56 Cleanup feature proposal template 2016-07-13 23:54:38 +00:00
Connor Shea 629b4e68e8
Add License Finder information to contribution acceptance criteria. 2016-06-07 11:23:26 -06:00
Achilleas Pipinellis ef85b8c329 Merge branch 'fix-design-link-in-contributing' into 'master'
Fix link to current design reference in the CONTRIBUTING guide

## What does this MR do?

It fixes an outdated link by replacing it with the up-to-date one.

See merge request !4439
2016-06-04 12:32:12 +00:00
Zeger-Jan van de Weg 7cc897d74e Let contributors know where to start
gitlab-org/gitlab-ce/issues/14905#note_12235996
2016-06-03 09:16:45 +00:00
Rémy Coutable bc351d5ac6
Fix link to current design reference in the CONTRIBUTING guide
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-06-02 18:10:16 +02:00
Rémy Coutable ea80259b48
Don't advertise the use of "ci skip" in the CONTRIBUTING guide
Now that we autoscale runner, we don't need to optimize for their usage
anymore. Abusing of "ci skip", for instance for view changes can lead to
broken specs, so let's just not use it!

Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-06-01 14:18:37 +02:00
Douwe Maan 72e4bd5fc4 Merge branch 'feature-proposal-contribution-guidelines' into 'master'
feature proposal issue template in contributing guide

This adds a feature proposal template to the contribution guidelines for internal and external use.

Fixes #15448 

cc @markpundsack @stanhu @dzaporozhets 

See merge request !3967
2016-05-04 14:46:24 +00:00
Robert Speicher 3e43214ff6 Merge branch 'link-to-code-review-guide' into 'master'
Link to GitLab code review guide in contributing guidelines

I noticed that the contributing guidelines still link to the thoughtbot
code review guidelines even though we already have our own.

[ci skip]

See merge request !4018
2016-05-03 22:05:32 +00:00
Karlo Soriano 1fddfa8f2a Link to gitlab code review guide in contributing guidelines
I noticed that the contributing guidelines still link to the thoughtbot
code review guidelines even though we already have our own.

[ci skip]
2016-05-03 21:18:22 +08:00
Job van der Voort 52a6b976a7 feature proposal issue template in contributing guide 2016-04-28 14:13:39 +02:00
Achilleas Pipinellis da4aaaacd7 Fix links to core team page
[ci skip]
2016-04-28 14:06:28 +03:00
Achilleas Pipinellis 8b817f5940 Users can use the feature proposal label inside the issue
[ci skip]
2016-04-28 12:43:23 +03:00
Jacob Schatz 962979d32a Articles on proper commit messages 2016-04-20 07:32:45 -04:00
Robert Speicher fb8b0041d8 First pass at a Testing styleguide
[ci skip]
2016-04-01 20:31:12 -04:00
Douwe Maan 691d5db598 Change capitalization 2016-03-18 12:11:41 +00:00
Achilleas Pipinellis efa1bc372f Fix typos and add a paragraph to urge people to mention the relevant MR
[ci skip]
2016-03-18 09:17:18 +02:00
Grzegorz Bizon f108cedf4a Add description of technical debt label in docs
[ci skip]
2016-03-17 08:01:13 +01:00
connorshea 8d8b457ceb Add SCSS Lint, CSSComb config file, run SCSS Lint in GitLab CI, add documentation for SCSS Style Guide.
See !3069 for more information.
2016-03-14 20:33:54 -06:00
Sytse Sijbrandij efe7a6b04c No options please. 2016-03-04 18:23:55 -08:00
Rémy Coutable a6f26598bc Add a paragraph on "Implementing design & UI elements" in CONTRIBUTING.md
Also, link to this new paragraph in PROCESS.md and improved a bit this
document.

[ci skip]
2016-03-01 18:56:23 +01:00
nozo a1db103a45 fix some links 2016-02-14 18:48:00 +00:00
Sytse Sijbrandij 5f07e13b7d Add notice about MR target for stable fixes 2016-02-10 17:36:23 +00:00
Achilleas Pipinellis e02f29b59d Rearrange some sections in CONTRIBUTING.md
[ci skip]
2016-02-08 12:12:29 +02:00
Achilleas Pipinellis 7fde90c25b Add table of contents in CONTRIBUTING.md 2016-02-08 11:23:30 +02:00
Robert Speicher b77cc8a133 Merge branch 'contributing-labels-stable-releases' into 'master'
Updated contributing guide for stable releases

[ci skip]

See merge request !2638
2016-02-02 15:53:58 +00:00
Dmitriy Zaporozhets b828e5faa4 Merge branch 'rs-regression-issue-guidelines' into 'master'
Add notes about the regression issues to CONTRIBUTING.md

[ci skip]

See merge request !2661
2016-02-02 11:08:50 +00:00
Yorick Peterse 9dfc4511ff Updated contributing guide for stable releases
Fixes #12784
2016-02-02 10:52:47 +01:00
Robert Speicher 797bcdf43e Add notes about the regression issues to CONTRIBUTING.md
[ci skip]
2016-01-31 15:56:27 -05:00
Sytse Sijbrandij 7d9856313d Link to Thoughtbot review guidelines. 2016-01-30 15:39:33 -08:00
Maverik Gately 6e6b5df60c add missing `RAILS_ENV=production` bit to bundle command 2016-01-27 14:27:57 +00:00
Achilleas Pipinellis 5a757a6389 Add new location of doc_styleguide in CONTRIBUTING.md
[ci skip]
2016-01-12 12:32:11 +01:00
Job van der Voort c68f8533aa add issue weight to contributing 2015-12-28 14:02:18 +01:00
Laurens Stötzel e5715c1ee7 Fixed wrong URL to "up for grabs" issue filter 2015-12-21 15:20:35 +01:00