|
1 | | -How to Contribute |
2 | | -================= |
| 1 | +# How to Contribute |
| 2 | + |
| 3 | +## Getting help |
3 | 4 |
|
4 | | -Getting help |
5 | | ------------- |
6 | 5 | To ask questions about the XBee Java Library go to the |
7 | 6 | [Digi Forum](http://www.digi.com/support/forum). |
8 | 7 |
|
9 | 8 |
|
10 | | -Reporting a bug |
11 | | ---------------- |
| 9 | +## Reporting a bug |
| 10 | + |
12 | 11 | The way to report bugs is to use the |
13 | | -[GitHub issue tracker](http://github.com/digidotcom/XBeeJavaLibrary/issues). |
| 12 | +[GitHub issue tracker](http://github.com/digidotcom/xbee-java/issues). |
14 | 13 | Before reporting a bug, please read the following points: |
15 | 14 |
|
16 | 15 | 1. Make sure that is really a bug by checking the |
17 | | -[documentation](http://docs.digi.com/display/XBJLIB) and consulting the |
18 | | -[FAQs](https://docs.digi.com/display/XBJLIB/Frequently+Asked+Questions+%28FAQs%29) |
| 16 | +[documentation](https://www.digi.com/resources/documentation/digidocs/90001438) and consulting the |
| 17 | +[FAQs](https://www.digi.com/resources/documentation/digidocs/90001438/#reference/r_xb_java_lib_faq.htm) |
19 | 18 | section. |
20 | 19 | 2. If you still think you have found a bug, make sure someone has not already |
21 | 20 | reported it. See the list of |
22 | | -[known issues](http://github.com/digidotcom/XBeeJavaLibrary/issues). |
| 21 | +[known issues](http://github.com/digidotcom/xbee-java/issues). |
23 | 22 | 3. If it has not been reported yet, create a new issue. Make sure to add enough |
24 | 23 | detail so that the bug can be reproduced. |
25 | 24 |
|
26 | 25 | **Note**: The issue tracker is for bugs, not requests for help. Questions |
27 | 26 | should be asked on the [Digi Forum](http://www.digi.com/support/forum) instead. |
28 | 27 |
|
29 | 28 |
|
30 | | -Suggesting a new feature |
31 | | ------------------------- |
32 | | -1. Consult the [FAQs](https://docs.digi.com/display/XBJLIB/Frequently+Asked+Questions+%28FAQs%29) |
| 29 | +## Suggesting a new feature |
| 30 | + |
| 31 | +1. Consult the [FAQs](https://www.digi.com/resources/documentation/digidocs/90001438/#reference/r_xb_java_lib_faq.htm) |
33 | 32 | section to ensure that the behavior you would like is not excluded. |
34 | 33 | 2. Make sure someone has not already requested it. See the list of |
35 | | -[known issues](http://github.com/digidotcom/XBeeJavaLibrary/issues). |
| 34 | +[known issues](http://github.com/digidotcom/xbee-java/issues). |
36 | 35 | 3. Submit your request in the issue tracker. |
37 | 36 |
|
38 | 37 |
|
39 | | -Contributing code |
40 | | ------------------ |
41 | | -1. Fork the [XBee Java Library](http://github.com/digidotcom/XBeeJavaLibrary) |
| 38 | +## Contributing code |
| 39 | + |
| 40 | +1. Fork the [XBee Java Library](http://github.com/digidotcom/xbee-java) |
42 | 41 | repository ([how to fork a repo](https://help.github.com/articles/fork-a-repo/)). |
43 | 42 | 2. Create a branch for your contribution. Use a name that defines the purpose of the additions/modifications. |
44 | 43 | 3. Make your changes following the code style used in the library. |
|
0 commit comments