|
| 1 | +# Roadmap |
| 2 | + |
| 3 | +We manage the project roadmap in trello. There is a [public board](https://trello.com/b/Wj9U0ulk/angular-meteor) |
| 4 | +dedicated to `angular-meteor`. You can add a card about what you want to see in the library or in the tutorial. |
| 5 | + |
| 6 | +# Issues |
| 7 | + |
| 8 | +Before you open up an issue, please check if the issue already exists or have been closed before. |
| 9 | + |
| 10 | +In general, when you open an issue for a feature request, please add as much details as possible: |
| 11 | +* A description of the problem you're trying to solve |
| 12 | +* An overview of the suggested solution |
| 13 | +* If the feature changes current behavior, reasons why your solution is better. |
| 14 | + |
| 15 | +When reporting a bug, please be sure to include the following: |
| 16 | +* What version of `angular-meteor` you're using |
| 17 | +* If at all possible, an *isolated* way to reproduce the behavior |
| 18 | +* The behavior you expect to see, and the actual behavior |
| 19 | + |
| 20 | +# [Tutorial](http://angular-meteor.com/tutorial) |
| 21 | + |
| 22 | +Our goal with the tutorial is to add as many common use cases as possible. If you want to create and add your own |
| 23 | +chapter we would be happy to help you writing and adding it. |
| 24 | + |
| 25 | +Also if you want to record a video for a chapter we would love to help you. |
| 26 | + |
| 27 | +# Code |
| 28 | + |
| 29 | +We would love to get your pull requests. At any case, please make sure there is an issue or a trello card for the issue |
| 30 | +you are trying to solve. |
| 31 | + |
| 32 | +Your code should contain tests relevant for the problem you are solving. |
| 33 | + |
| 34 | +If you want to contribute and need help or don't know what should you do, you can [contact me directly](https://github.com/urigo) |
| 35 | + |
| 36 | +# Contribution setup |
| 37 | + |
| 38 | +## Setup repository |
| 39 | + |
| 40 | +Fork angular-meteor and clone the angular-meteor library to another directory named `angular` |
| 41 | +``` |
| 42 | +mkdir angular |
| 43 | +git clone https://github.com/[your_username]/angular-meteor.git angular |
| 44 | +``` |
| 45 | + |
| 46 | +There is a git hook that needed to be installed manually. |
| 47 | + |
| 48 | +```bash |
| 49 | +cd angular |
| 50 | +ln -s ../../validate-commit-msg.js .git/hooks/commit-msg |
| 51 | +``` |
| 52 | + |
| 53 | +## Commit message format |
| 54 | + |
| 55 | +This project follows the `angular` project git commit message format. |
| 56 | +Please refer to the [official documentation](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines). |
| 57 | + |
| 58 | +## Run local angular-meteor in your project |
| 59 | + |
| 60 | +Create your Meteor Project |
| 61 | + |
| 62 | +```bash |
| 63 | +meteor create myProject |
| 64 | +cd myProject |
| 65 | +``` |
| 66 | + |
| 67 | +Create a `packages` directory under your project's root folder and link your forked repo |
| 68 | + |
| 69 | +```bash |
| 70 | +cd myProject |
| 71 | +ln -s ~/path_to_your_repos/angular/packages/ |
| 72 | +``` |
| 73 | + |
| 74 | +Now you can start using your own copy of the `angular-meteor` project from `myProject`. |
| 75 | + |
| 76 | +## Running tests |
| 77 | + |
| 78 | +In the command line |
| 79 | +``` |
| 80 | +. run_tests.sh |
| 81 | +``` |
| 82 | + |
| 83 | +Then go to `localhost:3000` in your browser |
| 84 | + |
| 85 | +## Contributing to documentation and tutorials. |
| 86 | + |
| 87 | +Whether it's a typo, some clarification, or a whole new feature - here's how to get started: |
| 88 | + |
| 89 | +1. Clone angular-meteor on your local machine |
| 90 | +2. Go to the docs directory at `cd docs/angular-meteor` |
| 91 | +3. Run the app for the documentation `meteor` |
| 92 | +4. Start tweaking and updating! |
0 commit comments