Skip to content

Commit

Permalink
Clean onboarding merge markups and fix old links. (#72)
Browse files Browse the repository at this point in the history
* Correct links and take out merge issues.

* Change styleguide to geck in links and text.
  • Loading branch information
hcs0 committed Dec 14, 2017
1 parent 8cdf0b1 commit 3a5b60b
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 24 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ Below is a guide that you can follow to make changes to this repo:
Create a new branch and check out to that branch so that you are working on
your own branch and not the master branch.

``git checkout -b styleguide-improvements`` with
``styleguide-improvements`` as an example branch name.
``git checkout -b geck-improvements`` with
``geck-improvements`` as an example branch name.

If there is a Trac ticket/ GitHub issue involved, add the ID at the
beginning of the branch name::

1234-styleguide-improvements
1234-geck-improvements

Once all changes are made, git push your changes out to your git branch
(not the `master` branch) and create the first Pull Request.
28 changes: 11 additions & 17 deletions docs/office/onboarding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ To practice your GitHub issue management skills, create your milestone as 'YOUR-

Below is a list of initial issues/tasks to be added in the milestone:

**Review and provide feedback for chevah/styleguide**
**Review and provide feedback for chevah/geck**

- The styleguide is at http://styleguide.chevah.com/
- geck is at http://geck.chevah.com/

- Comments/suggestions can be added in the ticket.

Expand All @@ -44,7 +44,7 @@ When submitting repo changes based on your feedback:

- Create pull requests (PRs) with these changes.

- Use the `Github PR template <https://github.com/chevah/styleguide/blob/463556d4e9219e28fd030759ba7af9c0a3ec89e6/.github/PULL_REQUEST_TEMPLATE>`_ and @ mention the oboarding supervisor for review.
- Use the `Github PR template <https://github.com/chevah/geck/blob/463556d4e9219e28fd030759ba7af9c0a3ec89e6/.github/PULL_REQUEST_TEMPLATE>`_ and @ mention the oboarding supervisor for review.

**Review and provide feedback for the software**

Expand Down Expand Up @@ -83,10 +83,10 @@ For any of the tasks above, feel free to check existing or previous milestones f
We have basic requirements and practices when working for the Chevah project.
Ask the tech lead for any questions.

* Take note of the `coding conventions <http://styleguide.chevah.com>`_ applied for this project. These general coding conventions are for all 'texts' (code, documentation, etc).
* Take note of the `coding conventions <http://geck.chevah.com/>`_ applied for this project. These general coding conventions are for all 'texts' (code, documentation, etc).

* There are specific rules that apply to programming languages.
Begin by reading the general `coding conventions <http://styleguide.chevah.com>`_.
Begin by reading the general `coding conventions <http://geck.chevah.com/en/latest/styleguide/index.html>`_.
Then review each language specific convention as you will be writing in that language.

* While you are in IRC on #chevah "in the office", set to auto-away to let others know that you are not at the computer.
Expand All @@ -98,10 +98,10 @@ Set the away status to "busy" (/away busy) if you are working at something and d
Ask tech lead for details.

* Each task that you are working on should have a ticket in Trac/Github.
If there is no ticket, create one and start the `Ticket Work Flow <http://styleguide.chevah.com/tickets.html>`_.
If there is no ticket, create one and start the `Ticket Work Flow <http://geck.chevah.com/en/latest/product/tickets.html>`_.

* While some tasks are on Github, there is a Trac/Github integration.
See `Overview of the GitHub and Trac integration <http://styleguide.chevah.com/review.html#overview-of-the-github-and-trac-integration>`_.
See `Overview of the GitHub and Trac integration <http://geck.chevah.com/en/latest/programming/review.html>`_.

* Tickets corresponding to you that you are currently working should have the 'owner' value set to your Trac username.

Expand All @@ -111,15 +111,10 @@ See `Overview of the GitHub and Trac integration <http://styleguide.chevah.com/r

* From time to time, check the Trac timeline to stay up to date with latest changes in the project.

<<<<<<< HEAD:content/onboarding.rst
* When starting a support ticket, request the OS version architecture used and version of the products.
=======
* When starting a support ticket, request the OS version architecture used and version of the SFTPPlus products.
Further details in Trac.
>>>>>>> master:docs/office/onboarding.rst

* Before a Pull Request is closed, it must be reviewed by at least one other team member.
Further info of the `Review process <http://styleguide.chevah.com/review.html>`_.
* Before a Pull Request is closed, it must be approved by at least one other team member.
Further info of the `Review process <http://geck.chevah.com/en/latest/programming/review.html>`_.

* Leave days can be requested at any time.
Check the dedicated page in Trac.
Expand Down Expand Up @@ -156,9 +151,8 @@ Use the dedicated Skype account as the official tools to collaborate with the te
* You will need a Trac account setup.
Trac tickets are used for managing work items since there is no support with the web-based GitHub issue/task/defect management
Trac also contains wiki pages to other documentation.
<<<<<<< HEAD:content/onboarding.rst
=======
Get to know the team by checking the dedicated page in our private wiki.

* Get to know the team by checking the dedicated page in our private wiki.


4. Exploring SFTPPlus for the first time
Expand Down
6 changes: 3 additions & 3 deletions docs/programming/review.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ For the person requesting a review

* Before submitting a ticket for review, check that you have documented your
work accordingly, for example in the affected repository documentation,
the ticketing system, or the Styleguide.
the ticketing system, or geck.

* When submitting a review for changes not planned in the current milestone,
update the milestone to the current one.
Expand Down Expand Up @@ -182,7 +182,7 @@ Review request message

When submitting a ticket for review, the review request should contain the
following message as described in `pull request template
<https://github.com/chevah/styleguide/blob/master/.github/PULL_REQUEST_TEMPLATE>`_:
<https://github.com/chevah/geck/blob/master/.github/PULL_REQUEST_TEMPLATE>`_:

The PR title should be the merge commit message.
The message should include the ticket ID number.
Expand Down Expand Up @@ -294,7 +294,7 @@ Reviewer's check list - Any Role
Reviewer's check list - Developer
---------------------------------

* Do the **new** changes comply with latest styleguide?
* Do the **new** changes comply with geck?

* Does the code have automated tests for all the new code?

Expand Down
2 changes: 1 addition & 1 deletion docs/styleguide/bash.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Always double quote path constants to handle files with spaces:
command "${SOME_PATH}/some.file"

# Another example
REMOTE_URI=chevah@chevah.com:/home/chevah/styleguide.chevah.com/vm/
REMOTE_URI=chevah@chevah.com:/home/chevah/geck.chevah.com/vm/
scp "$LOCAL_FILE" "${REMOTE_URL}/file"

Instead of:
Expand Down

0 comments on commit 3a5b60b

Please sign in to comment.