Skip to content

Commit 10ddbe7

Browse files
committed
docs(contribution): Add more contribution guidelines in a separated file
1 parent 4b9b853 commit 10ddbe7

File tree

2 files changed

+93
-67
lines changed

2 files changed

+93
-67
lines changed

CONTRIBUTING.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
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!

README.md

Lines changed: 1 addition & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -35,74 +35,8 @@
3535
2. Install angular-meteor `$ bower install angular-meteor`
3636

3737
## Contributing
38-
We would love contributions in:
39-
40-
1. Code - We would love to get your pull requests, just don't forget the tests..
41-
2. [Tutorial](http://angular-meteor.com/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.
42-
3. [Roadmap](https://trello.com/b/Wj9U0ulk/angular-meteor) - you can add a card about what you want to see in the library or in the tutorial.
43-
4. I ([Urigo](https://github.com/urigo)) live around the world with one small bag, so another way of contributing can be by offering me a place to sleep somewhere interesting around the world that I have to see :)
44-
45-
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)
46-
47-
### Commit message format
48-
49-
This project follows the `angular` project git commit message format.
50-
Please refer to the [official documentation](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines).
51-
52-
## Contributor Developer Setup
53-
54-
### Setup repository
55-
56-
There is a git hook that needed to be installed manually.
57-
58-
```bash
59-
git clone https://github.com/<Your Username>/angular-meteor.git
60-
cd angular-meteor
61-
ln -s ../../validate-commit-msg.js .git/hooks/commit-msg
62-
```
63-
64-
### Run local angular-meteor in your project
65-
66-
Create your Meteor Project
67-
68-
```bash
69-
meteor create myProject
70-
cd myProject
71-
```
72-
73-
Fork angular-meteor and clone the angular-meteor library to another directory named `angular`
74-
```
75-
mkdir angular
76-
git clone https://github.com/[your_username]/angular-meteor.git angular
77-
```
78-
79-
Create a `packages` directory under your project's root folder and link your forked repo
80-
81-
```bash
82-
cd myProject
83-
ln -s ~/path_to_your_repos/angular/packages/
84-
```
85-
86-
Now you can start using your own copy of the `angular-meteor` project from `myProject`.
87-
88-
### Running tests
89-
90-
In the command line
91-
```
92-
. run_tests.sh
93-
```
94-
95-
Then go to `localhost:3000` in your browser
96-
97-
### Contributing to documentation and tutorials.
98-
99-
Whether it's a typo, some clarification, or a whole new feature - here's how to get started:
100-
101-
1. Clone angular-meteor on your local machine
102-
2. Go to the docs directory at `cd docs/angular-meteor`
103-
3. Run the app for the documentation `meteor`
104-
4. Start tweaking and updating!
10538

39+
Please read the contributing instructions at [the contributing page](https://github.com/Urigo/angular-meteor/blob/master/CONTRIBUTING.md).
10640

10741
## Usage
10842

0 commit comments

Comments
 (0)