Skip to content
Connecting developers with mentors worldwide.
Branch: develop
Clone or download
jwithington and emmawedekind Fix for Slack link (#311)
* update join link for slack

* update README slack invite link
Latest commit a1b3558 Mar 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update pull request template (#178) Oct 29, 2018
.storybook Upgrade storybook to be compatible with CRA2 (#260) Dec 10, 2018
public remove unnecessary classes from body and app containers (#282) Jan 8, 2019
src Adding the link to mentors app (#309) Mar 12, 2019
tests/setup Proposal for react-testing-library (#31) Sep 14, 2018
.editorconfig
.env
.eslintrc
.gitignore Feature/remove env from gitignore (#301) Feb 6, 2019
.linguirc
.prettierrc
.travis.yml
CNAME Migrating files Sep 10, 2018
README.md
package.json [Feature/GA] Adding GA to track pages (#304) Feb 6, 2019
postcss.config.js [Feature] Adding tailwind to our stack (#219) Nov 8, 2018
tailwind.js
yarn.lock [Feature/GA] Adding GA to track pages (#304) Feb 6, 2019

README.md

Coding Coach

Build Status contributions welcome

Connecting developers with mentors worldwide.

Getting started

  1. Clone this repo
https://github.com/Coding-Coach/coding-coach.git
  1. Install the node modules and starting the server:
yarn
yarn start

Slack

Coding Coach is on Slack! Click here to join.

Styling

Initially we decided to use SASS to handle the CSS. However, over time we decided to use tailwind! We are currently migrating all our styles to tailwind.

Please, every new PR should be using tailwind for styling the components. Eventually we want to remove SASS, but for now it will be still there to support legacy code.

Internationalization

One of the goals we have with this platform is to provide mentorship all over the world, therefore we want to support as many languages as possible.

We are using LinguiJS as the library to enable i18n support. Lingui provides a CLI tool to manage the keys and texts. When working on a new feature that requires you to add some text, we are going to use the CLI to insert that new text into the dictionaries. Follow these steps:

First you need to define the key in the code:

  <p><Trans id="home.header.title" /></p>

Then in your terminal you need to extract all the keys running the following command:

$ yarn i18n-extract

Catalog statistics:
┌──────────┬─────────────┬─────────┐
│ Language │ Total count │ Missing │
├──────────┼─────────────┼─────────┤
│ en       │     18      │    1    │
│ es       │     18      │   18    │
│ fr       │     18      │   18    │
└──────────┴─────────────┴─────────┘

(use "lingui add-locale <language>" to add more locales)
(use "lingui extract" to update catalogs with new messages)
(use "lingui compile" to compile catalogs for production)
✨  Done in 2.95s.

At this point the key will be inserted into all dictionaries, and we will also see a nice count of the missing keys, in this example for english there's only one key missing for translation (The one we just defined in our code), but for the other languages we need to translate them all. This is a nice feature because we can easily know which translations are missing.

Open the src/config/i18n/en/messages.json file (not the .js but the .json file) and add the translation to the new key, if you can speak other languages, please go ahead and add the translations as well, if not we can leverage in our community to add the missing translations later on.

Finally we need to compile the dictionaries, just run the following command in your terminal:

$ yarn i18n-compile

This will generate the compiled dictionaries that our app will be using.

Coding Coach Board

In order to organize all the work, we are using https://zenhub.com to keep track of all the epics and tasks. After you login to ZenHub search for the Coding-Coach/coding-coach repository, make sure you don't add someone else fork.

Workflow

This section describes the workflow we are going to follow when working in a new feature or fixing a bug. If you want to contribute, please follow these steps:

  1. Fork this project
  2. Clone the forked project to your local environment, for example: git clone git@github.com:crysfel/coding-coach-front-end.git (Make sure to replace the URL to your own repository).
  3. Add the original project as a remote, for this example the name is upstream, feel free to use whatever name you want. git remote add upstream git@github.com:Coding-Coach/coding-coach.git.

Forking the project will create a copy of that project in your own GitHub account, you will commit your work against your own repository.

Updating your local

In order to update your local environment to the latest version on develop, you will have to pull the changes using the upstream repository, for example: git pull upstream develop. This will pull all the new commits from the origin repository to your local environment.

Features/Bugs

When working on a new feature, create a new branch feature/something from the develop branch, for example feature/login-form. Commit your work against this new branch and push everything to your forked project. Once everything is completed, you should create a PR to the original project. Make sure to add a description about your work.

When fixing a bug, create a new branch fix/something from the develop branch, for example fix/css-btn-issues. When completed, push your commits to your forked repository and create a PR from there. Please make sure to describe what was the problem and how did you fix it.

Updating your local branch

Let's say you've been working on a feature for a couple days, most likely there are new changes in develop and your branch is behind. In order to update it to the latest (You might not need/want to do this) you need to pull the latest changes to develop and then rebase your current branch.

$ git checkout develop
$ git pull upstream develop
$ git checkout feature/something-awesome
$ git rebase develop

After this, your commits will be on top of the develop commits. From here you can push to your origin repository and create a PR.

You might have some conflicts while rebasing, try to resolve the conflicts for each individual commit. Rebasing is intimidating at the beginning, if you need help don't be afraid to reach out in slack.

Pull Requests

In order to merge a PR, it will first go through a review process. Once it is approved, we will merge to the develop branch using the Squash button in github.

When using squash, all the commits will be squashed into one. The idea is to merge features/fixes as oppose of merging each individual commit. This helps when looking back in time for changes in the code base, and if the PR has a great comment, it's easier to know why that code was introduced.

You can’t perform that action at this time.