Running locally
curl https://install.meteor.com/ | sh
git clone https://github.com/howlongistheline/howlongistheline.org.git
Note: if you want to edit things and send a pull request you should fork this project on GitHub first and clone your fork instead of https://github.com/howlongistheline/howlongistheline.org.git.
meteor npm install
meteor run
Run this from within the project directory while Meteor is running (it must be running to serve the local MongoDB instance):
cd ..
tar -xvf howlongistheline.org/mongodump.tar.gz
mongorestore -h 127.0.0.1 --port 3001 -d meteor dump/meteor
(You will need Mongo to be installed on your system).
If you already have the database but want to update it to the latest version, do a meteor reset from within the project directory before running the above, otherwise you will recieve duplicate key error errors.
If Mongo exits with status 1:
- Quick fix:
export LC_ALL=C - Proper fix: something is wrong with your OS locales, good luck.
If you do a git pull and Meteor doesn't start, the first thing to do is run meteor npm install as there may be package updates.
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 howlongistheline 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.
Step-by-step guide to sending a pull request
- Read the contribution protocol and the line by line explanation of the protocol.
- Fork this GitHub repository under your own GitHub account.
- Clone your fork locally on your development machine.
- 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: I'm claiming this issue before you start working on the issue, even if it is your own.
If at some point you want to abandon the issue and let someone else have a go, let people know by commenting on the issue.
- Add the howlongistheline repository as an upstream source and pull any changes:
git remote add upstream https://github.com/howlongistheline/howlongistheline.org.git # 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
- 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 themasterbranch, as themasterbranch is exclusively used to accept incoming changes fromupstream:masterand you'll run into problems if you try to use it for anything else. - 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 howlongistheline. - 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 howlongistheline, it should say This branch is even with howlongistheline:master.
If not, you need to pull the latest changes from the upstream howlongistheline 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 # this will replay your work on the new local branch which is now fully up to date with the howlongistheline 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. If you use -A to add everything, make sure you have your IDE stuff and local linting config etc in .gitignore, as we don't want that in the repo.
And then commit your changes:
git commit -m 'problem: <70 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
- 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 master branch of the howlongistheline repository.
- Send the pull request, be sure to mention the issue number with a # symbol at the front (e.g. #1014).
- Go back to the issue, and make a comment:
Done in #(PR_NUMBER)
Your change will be pushed to production, usually within a few hours. Everyone can then test your solution and whoever opened the issue can close it if it solves the problem.
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
Tests are not yet implemented, feel free to add tests if you wish. This will prevent others from breaking your changes later.
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:
- Contributors to howlongistheline 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.
- Anyone using any code from howlongistheline must also share their work under a share-alike license so that anyone else can use their improvements.
- No one can change the above, without explicit written permission from all contributors, which is practically impossible to get. That means even the founder of this project cannot ever relicense and sell howlongistheline or its code. 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 enforced through a variety of very creative methods leaving the perpetrator in a state of deep regret.