Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
github: add templates for bug reports and pull requests #1079
Also include all ivozprovider-users group in documentation and
updates FAQ to a numeric list for easy reference.
  • Loading branch information
Kaian committed Jul 26, 2019
1 parent e6c4eaa commit 7058684
Show file tree
Hide file tree
Showing 5 changed files with 126 additions and 16 deletions.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,48 @@
---
name: Bug report
about: Something is broken or not working

---

<!--
This project only uses GitHub Issues for bugs in the code or feature requests.
Please use this template only for bug reports.
Be sure you have read the project FAQ before submiting an issue.
* https://github.com/irontec/ivozprovider/blob/bleeding/FAQ.md
If you have trouble with your environment or a user question, please post them in ivozproider-users group
* https://groups.google.com/forum/#!forum/ivozprovider-users
You can delete next line and everything above before submitting (it is a comment).
-->

### Description
<!--
Explain what you did, what you expected to happen, and what actually happened.
-->

---

- IvozProvider version: <!-- You can get it from dpkg -l ivozprovider -->

- Related sections: <!-- Mark X between brackets to one or more sections -->
- [ ] SIP & Telephony
- [ ] vPBX Functionalities
- [ ] Billing & Invoicing
- [ ] Web Interface
- [ ] API
- [ ] Other

### Troubleshooting
<!--
If the issue can be reproduced, describe how it can be done.
If you have logs from journal add them here.
-->

### Additional Information
<!--
If you have extra information that does not fit previous sections, please add it here.
-->
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,37 @@
---
name: Feature Request
about: New functionalities or enhacing existing ones

---

<!--
This project only uses GitHub Issues for bugs in the code or feature requests.
Please use this template only for feature and enhacement requests.
Be sure you have read the project FAQ before submiting an issue.
* https://github.com/irontec/ivozprovider/blob/bleeding/FAQ.md
Expecially the section related to feature requests.
Beware that features are only implemented in the testing release.
You can delete next line and everything above before submitting (it is a comment).
-->

### Description
<!--
Explain in detail what the feature is about.
-->

---

- I'm willing to: <!-- Mark X between brackets if they apply -->

- [ ] Implement this feature myself
- [ ] Pay to priorize this new feature

### Additional Information
<!--
If you have extra information that does not fit previous sections, please add it here.
-->
23 changes: 23 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,23 @@
<!--
- All pull requests must be done against bleeding branch.
- All provided code must be GPLv3 license compatible.
-->

#### Type Of Change <!-- Mark one with X -->
- [ ] Small bug fix
- [ ] New feature or enhancement
- [ ] Breaking change

#### Checklist:
- [ ] Commits are named and have tag following [commit rules](https://github.com/irontec/ivozprovider/blob/bleeding/doc/dev/en/commits.md)
- [ ] Commits are split per component (schema, web/admin, kamusers, agis, ..)
- [ ] Changes have been tested locally
- [ ] Fixes an existing issue (Fixes #XXXX) <!-- Replace XXXX with issue id -->

#### Description
<!-- Describe your changes in detail -->

#### Additional information
<!--
If you have extra information that does not fit previous sections, please add it here.
-->
32 changes: 16 additions & 16 deletions FAQ.md
@@ -1,19 +1,19 @@
# Frequently Asked Questions

## Table of Contents
* [What is IvozProvider?](#what-is-ivozprovider)
* [Is IvozProvider free?](#is-ivozprovider-free)
* [I would like to try, where should I start?](#i-would-like-to-try-where-should-i-start)
* [What release should I use?](#what-release-should-i-use)
* [Can I use IvozProvider without public IP address?](#can-i-use-ivozprovider-without-public-ip-address)
* [I have trouble with my environment!](#i-have-a-trouble-with-my-environment)
* [I have found a bug](#i-have-found-a-bug)
* [I have a feature request](#i-have-a-feature-request)
* [What language should I use while reporting?](#what-language-should-i-use-while-reporting)
* [I have tested standalone, how can I install a distributed installation?](#i-have-tested-standalone-how-can-i-install-a-distributed-installation)
* [This solution is not useful without this feature](#this-solution-is-not-useful-without-this-feature)
* [I would like to contribute](#i-would-like-to-contribute)
* [How can I setup a development environment of the project?](#how-can-i-setup-a-development-environment-of-the-project)
1. [What is IvozProvider?](#what-is-ivozprovider)
2. [Is IvozProvider free?](#is-ivozprovider-free)
3. [I would like to try, where should I start?](#i-would-like-to-try-where-should-i-start)
4. [What release should I use?](#what-release-should-i-use)
5. [Can I use IvozProvider without public IP address?](#can-i-use-ivozprovider-without-public-ip-address)
6. [I have trouble with my environment!](#i-have-a-trouble-with-my-environment)
7. [I have found a bug](#i-have-found-a-bug)
8. [I have a feature request](#i-have-a-feature-request)
9. [What language should I use while reporting?](#what-language-should-i-use-while-reporting)
10. [I have tested standalone, how can I install a distributed installation?](#i-have-tested-standalone-how-can-i-install-a-distributed-installation)
11. [This solution is not useful without this feature](#this-solution-is-not-useful-without-this-feature)
12. [I would like to contribute](#i-would-like-to-contribute)
13. [How can I setup a development environment of the project?](#how-can-i-setup-a-development-environment-of-the-project)

### What is IvozProvider?

Expand Down Expand Up @@ -46,10 +46,10 @@ That address must be present in your network interfaces in order to bind service
### I have trouble with my environment!

We don't provide any kind of free support for installations. If you have trouble, you can contact our sales department
at comercial@irontec.com
at comercial@irontec.com or ask in [ivozprovider-users](https://groups.google.com/forum/#!forum/ivozprovider-users) group.

If by any chance you receive support in Github or #ivozprovider freenode IRC channel, it's most probably provided
during developers spare time, so be thankful for the people giving part of their time.
If by any chance you receive support in the group or #ivozprovider freenode IRC channel by any developer, it's most
probably provided during spare time, so be thankful for the people giving part of their time.

### I have found a bug

Expand Down
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -75,6 +75,8 @@ Any feedback is also welcomed at [#ivozprovider irc channel](https://webchat.fre

You can read frequently asked questions [here](https://github.com/irontec/ivozprovider/blob/bleeding/FAQ.md).

For environment or functional questions, use [ivozprovider-users](https://groups.google.com/forum/#!forum/ivozprovider-users) group.

## Commercial support

Don't hesitate to [contact us](https://www.irontec.com/contacto) for support if you plan to create a multi instance installation or want any kind of help with your systems.
Expand Down

0 comments on commit 7058684

Please sign in to comment.