Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 2.86 KB

CONTRIBUTING.md

File metadata and controls

92 lines (61 loc) · 2.86 KB
Raw

Roadmap

We manage the project roadmap in trello. There is a public board dedicated to angular-meteor. You can add a card about what you want to see in the library or in the tutorial.

Issues

Before you open up an issue, please check if the issue already exists or have been closed before.

In general, when you open an issue for a feature request, please add as much details as possible:

  • A description of the problem you're trying to solve
  • An overview of the suggested solution
  • If the feature changes current behavior, reasons why your solution is better.

When reporting a bug, please be sure to include the following:

  • What version of angular-meteor you're using
  • If at all possible, an isolated way to reproduce the behavior
  • The behavior you expect to see, and the actual behavior

Tutorial

Our goal with the tutorial is to add as many common use cases as possible. If you want to create and add your own chapter we would be happy to help you writing and adding it.

Also if you want to record a video for a chapter we would love to help you.

Code

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 you are trying to solve.

Your code should contain tests relevant for the problem you are solving.

If you want to contribute and need help or don't know what should you do, you can contact me directly

Contribution setup

Setup repository

Fork angular-meteor and clone the angular-meteor library to another directory named angular

mkdir angular
git clone https://github.com/[your_username]/angular-meteor.git angular

There is a git hook that needed to be installed manually.

cd angular
ln -s ../../validate-commit-msg.js .git/hooks/commit-msg

Commit message format

This project follows the angular project git commit message format. Please refer to the official documentation.

Run local angular-meteor in your project

Create your Meteor Project

meteor create myProject
cd myProject

Create a packages directory under your project's root folder and link your forked repo

cd myProject
ln -s ~/path_to_your_repos/angular/packages/

Now you can start using your own copy of the angular-meteor project from myProject.

Running tests

In the command line

. run_tests.sh

Then go to localhost:3000 in your browser

Contributing to documentation and tutorials.

Whether it's a typo, some clarification, or a whole new feature - here's how to get started:

  1. Clone angular-meteor on your local machine
  2. Go to the docs directory at cd docs/angular-meteor
  3. Run the app for the documentation meteor
  4. Start tweaking and updating!