Support
From OpenSimulator
(Difference between revisions)
(→Before asking for help) |
|||
| (62 intermediate revisions by 13 users not shown) | |||
| Line 1: | Line 1: | ||
| − | == | + | {{Quicklinks}} |
| − | + | == Support and Contribution Process == | |
| + | === Before asking for help === | ||
* Check your configuration files for any obvious defects. | * Check your configuration files for any obvious defects. | ||
* Check that you're starting up the processes correctly. | * Check that you're starting up the processes correctly. | ||
| − | * | + | * Be sure to thoroughly search the [[User Documentation]] before asking for any help. |
| − | * | + | * Search the [[FAQ]] and [[Troubleshooting]] pages. |
| − | * | + | * Read the [[Definitions|Common Terms and Definitions]] |
| − | * | + | * Check the [[:Category:Tech Reference|Technical Reference]] Guide |
| − | * | + | * Check the [[News|Latest news]] page for recent updates |
| + | * Check for [http://opensimulator.org/mantis Known Bugs] | ||
| − | == | + | === Getting support === |
| − | + | ||
| − | + | ||
| − | + | OK, if you did all that and you still have a problem. Here's what you can do. | |
| − | + | ||
| − | + | # Ask on [[IRC]] on Libera.Chat #opensim and #opensim-dev. Approach them in that order :) Please be courteous and remember that the developers and anyone else assisting you are volunteers there, and have no obligation to help you. | |
| − | + | #* Don't ask to ask, just ask. | |
| − | * Don't ask to ask, just ask. | + | #* Phrase your question in the form of a question. |
| − | * Phrase your question in the form of a question. | + | #* Be specific. |
| − | * Be specific. | + | #* Explain the problem. |
| − | * Explain the problem. | + | #* Describe how to reproduce the problem. |
| − | * Describe how to reproduce the problem. | + | #* If you need to paste configuration files or error messages, please paste to [https://pastebin.com/ pastebin] then send the link in the IRC channel. |
| − | * If you need to paste configuration files or error messages, please paste to [ | + | # If no-one in IRC is able to help at the moment, you can try one of the [[Mailing Lists]] that are available for communication between users and developers. |
| + | # If you come to the conclusion that your problem results from an OpenSimulator bug, you can file a bug report (see below how). If you pursue this, make sure you have all the data that supports your bug report. Filing a good bug report that the developers will pay attention to requires a substantial effort on your part. If you are not willing to make that effort, don't bother to file a bug report. | ||
| − | + | If you aren't used to interacting with open source developers, we recommend reading [http://www.catb.org/~esr/faqs/smart-questions.html this]. At the very least you will be amused! | |
| − | + | ||
| − | + | === After you get help === | |
| − | * [ | + | * If the problem is a bug, and no-one is able to help you, please submit a [[Bugs|bug report]]. Read below for how to do this. |
| − | * | + | * If someone did help you, please document the problem and the solution on the wiki if it's not there yet |
| + | |||
| + | === Attending office hours === | ||
| + | If you would like to contribute to the project, the second thing you may want to do (after learning about the project) is visiting the in-world [[Office hours|OpenSimulator discussion hours]]. | ||
| + | |||
| + | == Reporting Bugs == | ||
| + | |||
| + | Please read the document [[Bugs|Reporting Bugs]] | ||
| + | |||
| + | == Known Issues == | ||
| + | [[BuildingIssues|Known issues when building in OpenSim]] | ||
| + | |||
| + | == Feature Requests == | ||
| + | |||
| + | You may have an idea for moving opensim into an interesting direction that hasn't been explored yet. If you do, the process is as follows: | ||
| + | |||
| + | * Describe your idea either in an email message or, better yet, somewhere on the Web. Then start a discussion about it on the opensim-dev mailing list, to have a feeling for what the developers think about your idea, and to get some advice on how to go about implementing it. If the feeling you get is that the developers are not interested, you can always implement your idea as a addon project or as your own proprietary extension. If you get the feeling that there is a chance your idea will be accepted as a core contribution, read on. | ||
| + | |||
| + | * Implement your idea on your own copy of opensim, and make it available for users and developers to try it out without much effort. The lower the effort for people to try it out, the higher the chances people will try it and accept it. | ||
| + | |||
| + | * If you're not a programmer, your only possible course of action is to convince some programmer (core or not) to implement it for you. Keep in mind that the opensim developers do not work for you, and are busy implementing the things that interest '''them'''. And if an idea is just an idea without code behind it, it will be ignored. | ||
| + | |||
| + | * Once you have an implementation, submit it to the developers for review via a patch. | ||
| + | |||
| + | == Submitting Patches == | ||
| + | |||
| + | Please review [[Submitting code to OpenSim]] | ||
| + | <!-- | ||
| + | <cleanpage title=hide cats=hide /> | ||
| + | --> | ||
Latest revision as of 02:19, 20 November 2021
Contents |
[edit] Support and Contribution Process
[edit] Before asking for help
- Check your configuration files for any obvious defects.
- Check that you're starting up the processes correctly.
- Be sure to thoroughly search the User Documentation before asking for any help.
- Search the FAQ and Troubleshooting pages.
- Read the Common Terms and Definitions
- Check the Technical Reference Guide
- Check the Latest news page for recent updates
- Check for Known Bugs
[edit] Getting support
OK, if you did all that and you still have a problem. Here's what you can do.
- Ask on IRC on Libera.Chat #opensim and #opensim-dev. Approach them in that order :) Please be courteous and remember that the developers and anyone else assisting you are volunteers there, and have no obligation to help you.
- Don't ask to ask, just ask.
- Phrase your question in the form of a question.
- Be specific.
- Explain the problem.
- Describe how to reproduce the problem.
- If you need to paste configuration files or error messages, please paste to pastebin then send the link in the IRC channel.
- If no-one in IRC is able to help at the moment, you can try one of the Mailing Lists that are available for communication between users and developers.
- If you come to the conclusion that your problem results from an OpenSimulator bug, you can file a bug report (see below how). If you pursue this, make sure you have all the data that supports your bug report. Filing a good bug report that the developers will pay attention to requires a substantial effort on your part. If you are not willing to make that effort, don't bother to file a bug report.
If you aren't used to interacting with open source developers, we recommend reading this. At the very least you will be amused!
[edit] After you get help
- If the problem is a bug, and no-one is able to help you, please submit a bug report. Read below for how to do this.
- If someone did help you, please document the problem and the solution on the wiki if it's not there yet
[edit] Attending office hours
If you would like to contribute to the project, the second thing you may want to do (after learning about the project) is visiting the in-world OpenSimulator discussion hours.
[edit] Reporting Bugs
Please read the document Reporting Bugs
[edit] Known Issues
Known issues when building in OpenSim
[edit] Feature Requests
You may have an idea for moving opensim into an interesting direction that hasn't been explored yet. If you do, the process is as follows:
- Describe your idea either in an email message or, better yet, somewhere on the Web. Then start a discussion about it on the opensim-dev mailing list, to have a feeling for what the developers think about your idea, and to get some advice on how to go about implementing it. If the feeling you get is that the developers are not interested, you can always implement your idea as a addon project or as your own proprietary extension. If you get the feeling that there is a chance your idea will be accepted as a core contribution, read on.
- Implement your idea on your own copy of opensim, and make it available for users and developers to try it out without much effort. The lower the effort for people to try it out, the higher the chances people will try it and accept it.
- If you're not a programmer, your only possible course of action is to convince some programmer (core or not) to implement it for you. Keep in mind that the opensim developers do not work for you, and are busy implementing the things that interest them. And if an idea is just an idea without code behind it, it will be ignored.
- Once you have an implementation, submit it to the developers for review via a patch.
[edit] Submitting Patches
Please review Submitting code to OpenSim
