Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update index.md.hbs #7

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 21 additions & 16 deletions templates/pages/contrib/index.md.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,36 @@ section: development
title: Contribution Guideline
---

> Feeling like part of this Troop? Here's how you can contribute.
> Thank you for your interest in contributing to TroopJS. We value and welcome everyone's opinion so in order to encourage you, we'll try to make the guidelines simple and sweet.

## Questions
##Let us hear your pain.

We love questions, and we love knowing how you're using TroopJS. Please create a new issue in TroopJS's
revelant modules repositories, e.g. [troopjs-core](https://github.com/troopjs/troopjs-core) but not in
the bundle [repository](https://github.com/troopjs/troopjs) unless it truely cannot fall into any of the existing modules.
Most of the modules that's been added to the TroopJS framework are a result of feedback gathered from our early adopters. Help us make TroopJS work for you by [letting us hear your pain](https://github.com/troopjs/troopjs/issues/new). Remember to be nice and say please.

## Reporting issues
##Satisfied with TroopJS?

Please read the following guidelines before opening any issue.
Good. [It will be wonderful if you can tell us why](https://github.com/troopjs/troopjs/issues/new).

##Questions/ Discussions?

Please visit our discussion forum.

1. **Search for existing issues.** To avoid duplicate issues, it would help us out if you could please check first to see if someone else has reported the same issue. Moreover, the issue may have already been resolved with a fix available.
2. **Create an isolated and reproducible test case.** Be sure the problem exists in TroopJS's code with a [reduced test case](http://css-tricks.com/reduced-test-cases/) that should be included in each bug report.
3. **Include clear examples.** Make use of jsFiddle or jsBin to share your isolated test cases.
4. **Share as much information as possible.** Include version of Assemble, customized or vanilla build, etc. where appropriate. Also include steps to reproduce the bug.
## Reporting an issue

Please read the following guidelines before opening any issue.

1. **Search for existing issues.** Creating duplicate issues not only wastes your time, it slows us down too because it adds unnecessary admin work. Before you create an issue, check if the issue you are about to report already exists or if it's been resolved with a fix available.
2. **Create isolated and reproducible test cases.** To ensure that the problem exists in TroopJS's code by building a [reduced test case](http://css-tricks.com/reduced-test-cases/).
3. **Include clear examples.** Make use of jsFiddle or jsBin when you share your isolated test cases.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make use of jsFiddle, jsBin or gist when...

4. **Share as much information as possible.** Include version of Assemble, customized or vanilla build, etc. where appropriate.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Include version of TroopJS


## Pull requests

* Pull requests for each TroopJS module shall be rebased against the head of the `develop` branch
* Please refer from the PR to an existing issue to be explainatory
* Associated tests shall be included as part of the pull request changes.
* Changes shall follow our existing coding style especially in indentation and qutations
* Try not to pollute your pull request with unintended changes--keep them simple and small
* Pull requests for each TroopJS module will be rebased against the head of the `develop` branch.
* Reference an existing issue with your pull requests to be explanatory.
* Associated tests will be included as part of the pull request changes.
* Changes should follow our existing coding style especially indentation and quotations.
* Try not to pollute your pull request with unintended changes--keep them simple and small.

## Coding Style

Expand Down