Skip to content

Commit 44269b6

Browse files
committed
add contributing.md with notes on how to contribute to the eak website
Bluntly stolen from the ember.js CONTRIBUTING.md
1 parent 1bbc7d0 commit 44269b6

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

CONTRIBUTING.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Questions
2+
3+
This is the issue tracker for Ember App Kit.
4+
The Ember App Kit community uses this site
5+
to collect and track bugs and discussions of new features.
6+
If you are having difficulties or have a question about usage please ask a
7+
question on StackOverflow: http://stackoverflow.com/questions/ask and tag
8+
your question with `ember-app-kit`.
9+
10+
# Issues
11+
12+
Think you've found a bug or have a new feature to suggest? Let us know!
13+
14+
## Reporting a Bug
15+
1. Update to the most recent master release if possible. We may have already
16+
fixed your bug.
17+
18+
2. Search for similar issues. It's possible somebody has encountered
19+
this bug already.
20+
21+
3. Provide with a bug report that shows the problem.
22+
23+
4. If possible, submit a Pull Request with a failing test. Better yet, take
24+
a stab at fixing the bug yourself if you can!
25+
26+
The more information you provide, the easier it is for us to validate that
27+
there is a bug and the faster we'll be able to take action.
28+
29+
# Pull Requests
30+
31+
We love pull requests. Here's a quick guide:
32+
33+
1. Fork the repo.
34+
35+
2. Run the tests. We only take pull requests with passing tests
36+
37+
3. Add a test for your change. Only refactoring and documentation changes
38+
require no new tests. If you are adding functionality or fixing a bug, we need
39+
a test!
40+
41+
4. Make the test pass.
42+
43+
5. Commit your changes. If your pull request fixes an issue specify it in the commit message.
44+
Here's an example: `git commit -m "Close #52 – Fix controller and viewbindings"`
45+
46+
6. Push to your fork and submit a pull request. Please provide us with some
47+
explanation of why you made the changes you made. For new features make sure to
48+
explain a standard use case to us.
49+
50+
We try to be quick about responding to tickets but sometimes we get a bit
51+
backlogged. If the response is slow, try to find someone on IRC (#emberjs) to
52+
give the ticket a review.
53+
54+
# Website / Documentation
55+
56+
The project documentations is available at http://iamstef.net/ember-app-kit/
57+
58+
Ember App Kit is still under major development and contributions to the documentation are welcome!
59+
60+
1. Fork the repo.
61+
62+
2. Checkout the `gh-pages` branch
63+
64+
3. Make your changes
65+
66+
4. Commit and open a pull request against the `gh-pages` branch
67+
68+
69+
70+
NOTE: Partially copied from https://raw.github.com/emberjs/ember.js/master/CONTRIBUTING.md
71+

0 commit comments

Comments
 (0)