Skip to content

Contribution Guidelines

Jump to bottom
Iancam edited this page Dec 3, 2020 · 5 revisions

Start by getti

Github Flow

a very high level can be found here.

  • from the command line,
  • git clone https://github.com/FreeOpenUniversity/website-frontend.git && cd website-frontend
  • git pull
  • git checkout develop

You're home! this is where we merge new feature branches and make small commits (i.e. to update the readme). We Don't develop on main or master!!.

Adding Stuff

If you're looking to help, these links might help:

Creating a Feature

If you've thought of something you think we should build, or you've discovered a bug, you should make an issue for it in the Github project board. The left-most column is the backlog. Add your issue there.

Building a Feature

Figure out a task you'd like to work on here: kanban.

To assign yourself to a task, you need to change the task from a card to an issue, then click on the task. It should show up on the right. Click on assign in that right hand menu and select yourself.

Next, create an issue branch from the command-line.

create a branch like so:

git checkout -b issue_name

A convention is to include the issue number in the branch name, so git checkout -b i172_issueName

Lovely. Go forth and fix that bug, build that feature! When you're all done, commit your work:

  • git commit -am "I fixed all the things"

and push the results.

  • git push issue_name

Did it complain that upstream doesn't exist? That's normal. It'll give you a different command to run so that you can make it exist. Something like:

git push --set-upstream origin issue_name

Run that. It should then ask if you'd like to create a pull request. Heck yeah you want to make a pull request! That way, we'll all get a chance to review each other's code and push the project forward. Go to the link in the terminal's output. From there, things should be straightforward.

Code Review

We're here to learn from each other. That happens when others review our work, the more the better. Along with our own improvement, the codebase stays looking good, and allows us to nab bugs before they arise. At least 1 reviewer should check your stuff before its merged, but try to get 2 or 3 to look over it. If no one has reviewed your work, reach out to a teammate directly over Discord.

Submit your review notes to the original poster.

Clone this wiki locally