# Contributing to staruml-ruby

Contributions to staruml-ruby are very welcome. Please, have a look through the
guidelines in this file before submitting an issue or a pull request.

## Using issues

Use the [issue tracker][issuetracker] for reporting bugs, requesting new features,
and discussing. If you want to submit an issue,

* check the issue search first to prevent double submission of issues.
* the issue detail should be written clearly.

## Pull requests

Follow these guidelines below.

* use soft tabs set to 2 spaces.
* test your code first to make sure your code is working properly.
* commit message should contain what you changed (explain it clearly and capitalize
  its first letter).
* choose `dev` branch as your target branch (don't choose `master` branch).
* the pull request detail should be written for additional details.

## License

By contributing your code, you agree to license your contribution under the terms
of the [MIT License][license].

[issuetracker]: https://github.com/meisyal/staruml-ruby/issues
[license]: https://github.com/meisyal/staruml-ruby/blob/master/LICENSE

# Contributing to staruml-ruby

Contributions to staruml-ruby are very welcome. Please, have a look through the
guidelines in this file before submitting an issue or a pull request.

## Using issues

Use the [issue tracker][issuetracker] for reporting bugs, requesting new features,
and discussing. If you want to submit an issue,

* check the issue search first to prevent double submission of issues.
* the issue detail should be written clearly.

## Pull requests

Follow these guidelines below.

* use soft tabs set to 2 spaces.
* test your code first to make sure your code is working properly.
* commit message should contain what you changed (explain it clearly and capitalize
  its first letter).
* choose `dev` branch as your target branch (don't choose `master` branch).
* the pull request detail should be written for additional details.

## Useful Links

Here below are some useful links for developing StarUML extension.

* [StarUML main page][staruml]
* [StarUML developer's guide][starumldev]
* [StarUML API reference][starumlapi]

## License

By contributing your code, you agree to license your contribution under the terms
of the [MIT License][license].

[issuetracker]: https://github.com/meisyal/staruml-ruby/issues
[staruml]: http://staruml.io
[starumldev]: https://github.com/staruml/staruml-dev-docs/wiki
[starumlapi]: http://starumldocs-7a0.kxcdn.com/2.0.0/api
[license]: https://github.com/meisyal/staruml-ruby/blob/master/LICENSE

Add some useful links for developer
Add some useful links for developer
