Contribute - focallocal/fl-maps GitHub Wiki

###The first 6 steps to take if you want to contribute to this open-sourced project:

  1. Get your slack invite from here
  2. Say hello on the #meteor-maps channel in the Slack. One of us will add you as a collaborator to the repo, so that you'll be able to commit and push/pull to the app!
  3. Install Meteor and Node: docs.npmjs.com/cli/install if you don't already have them installed.
  4. Clone this repo to your computer by typing in the command line: git clone [email protected]:focallocal/fl-maps.git
  5. Install npm packages meteor npm install.
  6. settings.json is needed to start meteor for local development. it is not committed to the repo via a entry in .gitignore - use this gist to create the a local file in the project root settings.json
  7. Type meteor --settings settings.json in your terminal to start up the app in your browser (localhost:3000).
  8. Look at some of the open issues and identify one that sparks your interest. If you have any questions about it, you can leave a comment in there, or ask in the #meteor-maps Slack channel.

###What to work on The current milestone is: Brighter Tomorrow Map - look to close these issues before we work on the next group of functionality. feel free to ask any/all development related question to the #dev2dev slack channel - you'll find another developer that will be happy to assist. remember, we are mostly in different timezones; answers will likely have delayed responses. don't be shy

###How to work with branches.

  1. Type git branch -a to see a list of all the branches besides master, the default branch you're in.
  2. If you want to switch to a branch returned in the last, you would type git checkout BRANCHNAME.

###How to create a new branch to work on an issue below.

  • To work on a new feature/issue, you need to create a new branch for the issue. You can do it by typing:

    git checkout -b NAME_OF_NEW_BRANCH

  • So for example, if you wanted to work on issue #29 github.com/focallocal/fl-maps/issues/29, you should type:

    git checkout -b fix/issue-29-limit-140-characters

  • How you name your branch doesn't really matter as long as you put the issue number in there, so that other people can figure out what you're working on. Putting the number of the issue in your branch name helps prevent duplicate branches.

  • All right. After we've created our branch, the next step is to push our new branch to the repo by typing:

    git push origin NAME_OF_NEW_BRANCH

    Now we can make commits to our branch (git commit -am "commit message") and git pull to get other people's changes to the branch, and git push our own commits to the branch.

    Finally, when you're finished working on the fix or feature in your branch, you'll need to submit a pull request!

    Click on the "pull request" button by going to https://github.com/codebuddiesdotorg/cb-v2-scratch/pulls and clicking on "new pull request."

    Next, select your branch, and submit it against develop branch.

    One of the github maintainers (@mordka @codeluggage or @distalx) will look over your pull request and accept it.

If you see a bug in the app or have a feature request, feel free to create a new issue on the Github repo!