Skip to content

Latest commit

 

History

History
119 lines (90 loc) · 9.21 KB

README.md

File metadata and controls

119 lines (90 loc) · 9.21 KB
Raw

Emurgo Hong Kong Website

The problem

Emurgo Hong Kong operates independently and therefore requires it's own website to distinguish itself from the rest of the Emurgo group.

The solution

This repository contains the files used to render emurgohk.io. The site itself builds directly from master (docs directory). Pull requests that are merged are immediately (or thereabouts) reflected on the site itself.

How to run locally

Ensure that you have the latest version of nodejs and npm installed

Clone repository

git clone https://github.com/[github_usernamae]/website.git

Install Dependencies

cd website/ && npm install

Run website

npm run website (use npm run docs to run THEME documentation found at HELP/)

Contributing to the EmurgoHK Website

A cardinal sin that many open source developers make is to place themselves above others. "I founded this project thus my intellect is superior to that of others". It's immodest and rude, and usually inaccurate. The contribution policy we use at Emurgis applies equally to everyone, without distinction.

The contribution policy we follow is the Collective Code Construction Contract (C4)

If you're wondering why any of the rules in the C4 are there, take a look at the line by line explanation of everything in the C4, this explains the rationale and history behind everything in the protocol and makes it easier to understand.

As this is a new project without a strong pull request history, you should take a look at past pull requests from Blockrazor to see how to do things. You may also want to look at the bad pull request role of honour to see how not to send a pull request.

Step-by-step guide to sending a pull request

  1. Read the contribution protocol and the line by line explanation of the protocol.
  2. Fork this github repository under your own github account.
  3. Clone your fork locally on your development machine.
  4. Choose one problem to solve. If you aren't solving a problem that's already in the issue tracker you should describe the problem there (and your idea of the solution) first to see if anyone else has something to say about it (maybe someone is already working on a solution, or maybe you're doing somthing wrong).

It is important to claim the issue you want to work on so that others don't work on the same thing. Make a comment in the issue: @emurgobot claim before you start working on the issue.

If at some point you want to abandon the issue and let someone else have a go, comment: @emurgobot abandon.

  1. Add this repository as an upstream source and pull any changes:
@: git remote add upstream git://github.com/EmurgoHK/website //only needs to be done once
@: git checkout master //just to make sure you're on the correct branch
@: git pull upstream master //this grabs any code that has changed, you want to be working on the latest 'version'
@: git push //update your remote fork with the changes you just pulled from upstream master
  1. Create a local branch on your machine git checkout -b branch_name (it's usually a good idea to call the branch something that describes the problem you are solving). Never develop on the master branch, as the master branch is exclusively used to accept incoming changes from upstream:master and you'll run into problems if you try to use it for anything else.
  2. Solve the problem in the absolute most simple and fastest possible way with the smallest number of changes humanly possible. Tell other people what you're doing by putting very clear and descriptive comments in your code every 2-3 lines.
    Add your name to the AUTHORS file so that you become a part owner of Emurgis.
  3. Commit your changes to your own fork: Before you commit changes, you should check if you are working on the latest version (again). Go to the github website and open your fork of Emurigs, it should say This branch is even with Emurgis:master.
    If not, you need to pull the latest changes from the upstream Emurgis repository and replay your changes on top of the latest version:
@: git stash //save your work locally
@: git checkout master
@: git pull upstream master
@: git push
@: git checkout -b branch_name_stash
@: git stash pop //_replay_ your work on the new branch which is now fully up to date with the Emurgis repository

Note: after running git stash pop you should run Meteor and look over your code again and check that everything still works as sometimes a file you worked on was changed in the meantime.

Now you can add your changes:

@: git add changed_file.js //repeat for each file you changed

And then commit your changes:

@: git commit -m 'problem: <50 characters describing the problem //do not close the '', press ENTER two (2) times
>
>solution: short description of how you solved the problem.' //Now you can close the ''. Be sure to mention the issue number if there is one (e.g. #6)    
@: git push //this will send your changes to _your_ fork on Github
  1. Go to your fork on Github and select the branch you just worked on. Click "pull request" to send a pull request back to the Emurgis repository.
  2. Send the pull request, be sure to mention the issue number with a # symbol at the front (e.g. #1014).
  3. Go back to the issue, and make a comment: @emurgobot label "done". This will label this issue as complete, and everyone can test your solution and close the issue if it solves the problem.

What happens after I send a pull request?

If your pull request contains a correct patch (read the C4) a maintainer will merge it.
If you want to work on another problem while you are waiting for it to merge simply repeat the above steps starting at:

@: git checkout master
Rules for paid contributors

  1. Engage in discussion about problems even if you aren't working on them yourself. Be helpful to other contributors, many are volunteers who just want to be part of the project. You (should) have a pretty good understanding of the codebase and can probably save others a lot of time.

  2. Your code should be very clean and tidy, and easy to read. You should be able to look at your code a year later, in the morning before coffee, and immediately know what it's doing. Write code and comments like you are teaching someone else how to do what you're doing.

  3. Your pull requests should be a glowing example to others of how to work with the C4. Each one should be a model that others can refer to.

  4. In an ideal world, you would be able to work on any issue you want and there would be no need to assign tasks so that our budget is kept under control. This would be possible because you would always work on the the problems that are really worth solving right now to get to some form of MVP. We can't predict the future, there are no plans or roadmaps (these are not compatible with the C4). Emurgis grows through evolution not intelligent design or central planning. So if something isn't an in-your-face problem right now, it may never be, we could end up going down a totally different road before we get to it. While we want to avoid technical debt, we also don't want to be working on things that will someday maybe become a problem if Emurgis becomes a thing. Demonstrate that we can trust your own judgement on what you should be working on and what's worth spending time on.

License

The license and contribution policy are two halves of the same puzzle. This project is licensed under the MPL v2.0 license. The code is owned (and Copyright) by all contributors. Contributors are listed in the AUTHORS file. Please add your name to the end of this file in your first pull request so that you also become an owner.

This license ensures that:

  1. Contributors to this project cannot have their code stolen and used by closed-source projects without their permission. It's very common for corporate software merchants to steal code from open source projects and use it in their closed source or even patented products and services in direct competition with the original project. For example, anyone who contributes code to a project released under a BSD/MIT style license effectively has no rights to their own code or any improvements made upon it.
  2. Anyone using any code from this repository must also share their work under a share-alike license so that anyone else can use their improvements.
  3. No one can change the above, without explicit written permission from all contributors, which is essentially impossible to get. That means even the founder of this project cannot ever relicense and sell code from this repository. It belongs to everyone who contributed to it (and it always will).

It is not permissible to use any code from this codebase in anything that isn't using a share-alike license. Violations of the license will absolutely not be tolerated, and the terms of this license will be brutally enforced through a variety of very creative methods.