Skip to content

Commit

Permalink
Merge pull request #284 from cillianderoiste/docs-contrib-typos
Browse files Browse the repository at this point in the history
CONTRIBUTE.md: minor text changes, typos, spellings, missing articles
  • Loading branch information
garbas committed Feb 11, 2014
2 parents c958a91 + e436a91 commit 4526f9e
Showing 1 changed file with 39 additions and 37 deletions.
76 changes: 39 additions & 37 deletions CONTRIBUTE.md
@@ -1,68 +1,70 @@
# Code conventions

It's still on TODO list to write this down, but for now make sure you keep
jshint job happy.
It's still on the TODO list to write this down, but for now make sure you keep
jshint happy.

To run jshint on mockup code you have to type: ```make jsint```.
To run jshint on mockup code you have to type: ```make jshint```.


# Git workflow / branching model

It is important that you *NEVER* commit to master directly. Even for the
smallest and most trivial fix. *ALWAYS* send pull request and ask somebody else
to merge your code. *NEVER* merge it yourself.
smallest and most trivial fix. *ALWAYS* open a pull request and ask somebody
else to merge your code. *NEVER* merge it yourself.

If you dont get feedback on your pull request in a day please come to
If you don't get feedback on your pull request in a day please come to
```#plone-framework``` and ping ```@garbas``` or ```@vangheem``` about it.

Main goal of this process is not to boss developers around and make their live
harder, but to bring bigger stability to development of mockup and to make
releases smooth and predictable.
The main goal of this process is not to boss developers around and make their
lives harder, but to bring greater stability to the development of mockup and to
make releases smooth and predictable.


# Pull request checklist

Checklist of things that every person excepting pull request should follow (or
else @garbas will make you drink mongolian coctail - I promise!).
Checklist of things that every person accepting pull request should follow (or
else @garbas will make you drink a Mongolian cocktail - I promise!).

- Title and description of pull request *MUST* be descriptive and needs to
reflect changes in code. Please review line by line and comment if code
change was not mentioned in description of the pull request.
- The title and description of a pull request *MUST* be descriptive and need to
reflect the changes in code. Please review, line by line, and comment if the
code change was not mentioned in the description of the pull request.

- Copy the title of pull request to current ticket tracking changes for
realease under development. (example:
- Copy the title of the pull request to the current ticket tracking changes for
release under development. (example:
https://github.com/plone/mockup/issues/250)

- Full test suite (running test on saucelabs against real browsers) will only
be triggered for master branch and pull requests. It is important that tests
pass before you merge it.
- The full test suite (which runs the tests on saucelabs against real browsers)
will only be triggered for the master branch and the pull requests. It is
important that the tests pass before you merge it.

Please note that sometimes travis job hangs due to many reasons and you need
to restart it.
Please note that the Travis job sometimes hangs (for various reasons) and
then you need to restart it.

Due to some bugs on Travis reporting of status be sure to always check on
https://travis-ci.org/plone/mockup/pull_requests if the tests really passed.
Due to some bugs in Travis regarding reporting of the status, be sure to
always check on https://travis-ci.org/plone/mockup/pull_requests that the
tests really have passed.

- It is important never to lower code coverage. Check it on [coveralls](
https://coveralls.io/r/plone/mockup) if coverage dropped. It should be
automaticaly reported once tests are passing.
- It is important to never lower code coverage. Check [coveralls](
https://coveralls.io/r/plone/mockup) to see that coverage hasn't dropped. It
should be reported automatically once the tests pass.

Also make sure that every new function (or bigger chunk of code) that enters
Make sure that every new function (or bigger chunk of code) that is added to
mockup is tested.

- All commits need to be rebased on current master and squashed into one
single commit. Commit's title (first line) and description (row 3 and below)
should be identical to pull request.
- All commits need to be rebased on current master and squashed into one single
commit. The commit's title (first line) and description (row 3 and below)
should be identical to the pull request.

- If all of the above is checked, go ahead and merge pull request. Make sure
you always use a polite tone and explain why this is needed by linking to
this document.
- Once you've ensured that all the above is correct, go ahead and merge the
pull request. Make sure you always use a polite tone and explain why this is
needed by linking to this document.


# Changing this page

When changing this document, it must be done in public with a possibility for
other to comment or at least to be aware of the changes.
When changing this document, note that it must be done in public with the
possibility for others to comment or at least be aware of the changes.

Create a pull request with your proposed changes and describe the reasoning
behind the changes.

Create a pull request with proposed changes and describe reasoning why change
is needed.

0 comments on commit 4526f9e

Please sign in to comment.