Hey guys... I know this isn't the first one of these, and perhaps it's of no use to those of you who frequent XDA... but I wanted to at least give you a heads-up about another project going on:
http://www.capfaq.com/
It's more of a "newbie" resource and probably not of much value to those of you here more into advanced topics such as hacking, ROMs, etc. But maybe you field questions from newbies so this might give you something appropriate to refer them to (other than the other FAQ sites mentioned in the sticky, which are more for hacking/ROMs/etc).
Hopefully it'll be of use to someone. Cheers...
Related
OK ive been on this forum for some time. i dont have the many hours that lots of you appear to have to spend modding and adjusting the various XDA type devices covered on here.
My back ground is in electronics and not programing. I like to play with making things like adapters and connection devices. I get frustrated with my in ability to get the electronics to do what i want because it requires the programming side.
I have spent as much time as i can searching and following cross linked threads to find out the things i want to. it is also compounded by the various names and obvious differences between the same models and regions.
I have read the many posts by new people or people like myself who know what they want but dont always get the wording or the area that it is posted in correct. Many of the established members post the usual 'try searching before you post a question' well thats fine but if you dont know what you are looking for then how can you??
So the board has an FAQ section, to be honest that would be the first place i would look for information, there isnt much there to help people, its more about how to post stuff on the board and not FAQ on devices.
Im sure a lot of the new posts would be avoided if the established members/mods set up a list of the FAQ that people ask in there. The obvious ones like what the various terms are, A2DP etc... A list of various patches and what they do, a dload section for drivers, reg editors etc.
Now im wanting to get my XDA2i and Mini s to do what i want, i need to know this info.
Many people will just apply patches etc... i would like to see possibly an area that explains how and why things do what they do to help me understand more so i dont ask those anoying questions that the established members know the answers to.
So how about it MODS/Established members??
The FAQ link is there since we changed the forum to vBulletin, but it's a "default" vBulletin FAQ, not customized to xda-developers in any way.
The place to search for information is the wiki, there you'll find a lot of information on all the devices, and you have the possibility to edit it if you feel there's something missing.
I try to mantain the Hermes wiki up to date, it has a Hermes for Beginners section, a Hermes FAQs section, and a upgrading specific FAQ section.
But even with all the info on the wiki, and sticky posts in all the 3 hermes forums telling people to read the wiki before posting, we are getting the same questions again and again...
Below is a format that should be used as an example of how a rom thread should look. It doesnt have to be exact. I suggest that you stay creative and use all the features in the advanced panel when creating a thread.
1. Name of rom, team, etc
2. Introduction
3. Changelog in code or php tags
4. What's included in the rom in the (apps, tweaks, scripts, addons, mods) in code of php tags
5. What works/what doesn't work in code or php tags
6. Credits (Users name-with link to (profile/github/or thread u got tweak from embedded), and what they did to help you)
7. Screenshots (2-10 different screenshots of different aspects of rom)
8. Kernel with either link to thread you got it from or github (if stock sense or cm please state that and that is enough)
9. Instructions on how to install the rom (also if special instruction for a2sd or beats audio...etc)
10. Do's and Don'ts of the rom
11. Questions & Answers section (I find this helpful to write out asked questions with solutions at the bottom of the op. I find that it cuts down on the question being asked a million times)
12. Finally the dl link
13. Additional add-ons (this can go into first post or reserved posts after)
I find the embedded link looks and feels better throughout the op if possible.
All sections should have a header with enlarged text and spaced out so people can read it easily.
I am hoping that this helps to make this section a little cleaner and easier. enjoy
The way I look at this is that it takes US weeks/days/hours to make these roms....we can take the time out to make sure that the op looks professional and clean
Also Make sure the op is fully ready before posting. I know we all get excited to release a rom but stating that half the stuff will be updated as time permits just shows that you are lazy and in a hurry which doesnt look good cause if thats the case then how does your rom run....
No posting a a rom thread without a DL link either
Thanks Papa Smurf151 i think everyone who is getting ready to post a rom should be redirected here!
sorry if im not allowed to post here, so please delete my comment if needed
i left this open for feedback
How about how stable it is like in the old days?
I remember last year everyone would label them as beta, RC, final etc.
bennyboy78 said:
How about how stable it is like in the old days?
I remember last year everyone would label them as beta, RC, final etc.
Click to expand...
Click to collapse
I think what Papa Smurf outlined in the OP is more then enough and it covers the basics while keeping the majority of the threads uniformed or at least try to
I also don't think we should start being over critical here and require individuals that start threads in the development section to add labels like Alpha, Beta, MC, RC or whatever.
I understand that having labels would make things a whole lot easier for the user BUT it also doesn't encourage the user to read about what he or she flashes onto their phone.
I don't know how many times I've seen a user complain and harass developers over something that was clearly their (the user) fault because they didn't read the OP. They saw fancy screenshots and saw the download link and either ended up bricking their phone or causing their phone to turn into a hot pocket...lol
Not trying to tell people how to do their job BUT I think we should encourage users to read/search more not shortcut things for users.
Mazda said:
I think what Papa Smurf outlined in the OP is more then enough and it covers the basics while keeping the majority of the threads uniformed or at least try to
I also don't think we should start being over critical here and require individuals that start threads in the development section to add labels like Alpha, Beta, MC, RC or whatever.
I understand that having labels would make things a whole lot easier for the user BUT it also doesn't encourage the user to read about what he or she flashes onto their phone.
I don't know how many times I've seen a user complain and harass developers over something that was clearly their (the user) fault because they didn't read the OP. They saw fancy screenshots and saw the download link and either ended up bricking their phone or causing their phone to turn into a hot pocket...lol
Not trying to tell people how to do their job BUT I think we should encourage users to read/search more not shortcut things for users.
Click to expand...
Click to collapse
Well said, couldn't agree any more.
MBQsniper said:
Well said, couldn't agree any more.
Click to expand...
Click to collapse
See I assumed this was common sense and ROMs that are missing a lot of these details, I don't give the time of day too so those ROMs don't matter to me. Because in my mind all the good ROM's out there already follow this in some way shape or form.
I appreciate what you did but I don't see why we need it is all.
As long as these are only guidelines and not enforceable rules, I agree with them. But I wouldn't agree with deleting/locking threads that fail to follow these guidelines; that would send the wrong message to developers.
v5HMeca said:
As long as these are only guidelines and not enforceable rules, I agree with them. But I wouldn't agree with deleting/locking threads that fail to follow these guidelines; that would send the wrong message to developers.
Click to expand...
Click to collapse
Rom threads will never be locked or deleted for not following these guidelines. I would hope devs would embrace them and if a fellow dev isn't then I would hope someone would point them here and try to help them. Most rom devs want to have a nice looking op. But some of them are new and don't know better or are very young and don't know better. This just helps to give structure that they can refer to and say oh yeah maybe I should have that or this.
XDA Moderator
Cherokee4Life said:
See I assumed this was common sense and ROMs that are missing a lot of these details, I don't give the time of day too so those ROMs don't matter to me. Because in my mind all the good ROM's out there already follow this in some way shape or form.
I appreciate what you did but I don't see why we need it is all.
Click to expand...
Click to collapse
What?
As a previous maemo and iOS user, there was always an organized knowledge base where everything was sorted. From developer tools to user how-tos, to hacks and exploits, everything was documented in a wiki.
Although the userbase on xda is awesome, most of the information on the site is scattered; you have to go through hoops and loops to find something, and the post you found by googling might have been outdated.
I wanted to fix that, so I started Android Wiki, an encyclopedia based on MediaWiki (the software Wikipedia uses). It runs off my own personal server, if this ever takes off, I'll move it to a dedicated server.
Right now, the wiki has only one page about the Xposed Framework (as an example in my head of what this would look like [REDACTED]).
I'd really appreciate it if users can add more info to the wiki, this might help reduce questions asked in threads, and time wasted looking for stuff.
Here's a link to the wiki:
[REDACTED]
Background: Following some threads at XDA I’ve pretty early realised that quite a few bug reports, requests, and questions in regard to ROMs, kernels or applications are raised without sufficient information to allow (Recognised) Developers (RD), Recognised Contributors (RC), or other members to easily provide solid answers and recommendations or a possible fix. Everybody should remember even a highly professional member cannot read your mind.
Initially, I opened a thread with the same topic in regard to the device I use: The Samsung SGS3 LTE (GT-i9305). It’s accessible . If you already know that thread, I hope you don’t mind that I mostly copied and pasted.
Purpose: To provide some recommendations how to best phrase a request for support to possible ROM/kernel/applications issues in order to receive the most suitable answer and solution.
General recommendations:
Please read the XDA Forum Rules provided by @MikeChannon; a MUST READ for everybody who intends to post on XDA. Other MUST READ's I certainly recommend to everybody who wants to "breathe" what I believe the spirit of XDA is, are the following posts:
Forum Etiquette by @TheByteSmasher,
http://forum.xda-developers.com/show...postcount=2441 by @zelendel, and last but not least
http://forum.xda-developers.com/show...9&postcount=44 by @kyphur
Remember: Before you flash anything take a NANDROID backup or ensure you've an up-to-date one!
If you don’t know yet what’s hidden behind some of the expressions mentioned in the title of the following linked thread, just check it out: What is? Boot loader, custom ROMs, CWM, modem, kernel, flashing, rooting, ADB, baseband?? by @esimon311. Thanks to esimon311 for this great overview.
Guidance for useful modifications regarding some parts of your kernel can be obtained here: [GUIDE] Most up to date guide on CPU governors, I/O schedulers and more! by @Saber. Thanks to Saber for this great guide.
Before you post your issue or request, reboot at least once and try to replicate your problem. If it doesn't persist any longer the reboot might already have been the solution.
Read, read, and read again, read the OP (first post of each thread) and scan the respective thread. Use the search function of XDA. Remember: Make use of your friend – your favourite web-search engine. It does mean you have to read and study but I've no doubt you don't mind to do that for your device. Maybe, you'll find your required answer without having to post something.
A lot of OPs already contain hints how to solve commonly known issues.
Before you post in a ROM development thread, be sure not to run a custom kernel or Xposed. In case you use the latter, disable all Xposed modules and check if your issue still persists. Anyhow, if you’re using custom kernel or Xposed and you're convinced the issue is ROM related, you might post but mention the kernel and/or Xposed.
Last but not least: Don't ask what e.g. the best ROM, kernel or app is! All of them available at xda are great; however, each one of them has its different specification, capabilities, and pro's and con's depend on personal desire and expectations. The best one for you is the one, which meets your desire and expectation.
Before you post in a thread:
If you want to sell your car you probably achieve the better bargain the better (or more suitable) the portal is, in which you're offering it. I'm convinced you won't offer a car with the star at the bonnet on a webside covering military motorbikes.
Same applies to XDA. The more precise your post is going to fit into a thread or forum the faster and most likely better reply you're going to receive.
For this reason, I suggest you to exactly identify, in which of the 1000 fora or probably millions of threads to post. Prior to posting take you're time and study the following excellent guides and recommendations - all by @sd_shadow - to find the best and most reasonable place for your post.
[Guide] How and Where to Ask a Question on XDA
"Have Question about Posting?" in this post
[Index] of Help Threads (and Template)
When you post in a thread:
If available, post questions in Q&A threads (some threads have a dedicated Q&A section besides its development one) instead of the development thread. But if you have a solid bug report (never reported before, and your post is complying to all the required criteria provided below including all necessary info), you can post in a development thread.
Don't make a RD, RC or anybody else to read your mind. Don't have them to make assumptions – as soon as an assumption fails the whole solution is going to become void.
Please post your issue or request by using the English language as mentioned in the XDA rules to allow everybody to understand the post and hopefully to contribute, or at least to learn out of it. Don't be afraid if English isn't your native tongue – that's certainly the case for most of the xda users. A language barrier isn't an issue at XDA – as long as we all at least try to use the English language. Even if your English skills aren't too developed just use simple wording or a reasonable translator tool; nobody is going to blame you; however, try to be as precise and unambiguous as possible.
Always run a logging tool to be able to augment your post by a log file. Add the log as an attachment to your post or upload it into the cloud and provide the link in your post. Do not include the log into the text phrase of your post in order not to spam the thread. It doesn't matter, which logging tool you use but familiarise yourself with its use and where it saves the log. I'm personally e.g. using "Catlog" that saves logs to the internal storage. Alternatively use adb commands. Here is a [Tutorial] How To Logcat by @paxChristos. Thanks to paxChristos for this great tutorial.
If you're running (Ed)Xposed uninstall it, and take the log again (while Xposed is running, the log even states that it's useless because of Xposed).
Take screenshot(s) and attach them/it to your post. Don’t insert it/them into the “text box”. Before you take a screenshot, change your system language to English to allow everybody to understand the content of the screen.
Always provide exact and precise information about your issue. Write a description and, if possible, steps to allow for reproduction.
Unless the issue is only related to an application always provide exact and precise information about your device, the ROM, the kernel, your recovery, and specify the versions of the latter three. If you have issues with a theme, information regarding your ROM is certainly required. Occasionally information about your modem (or even bootloader) might also be helpful e.g. if you've problems with the RIL, mobile network or making phone calls. If you're on F2FS please mention.
If your issue or problem occurred immediately after you flashed a ROM* or kernel* or installed an application (incl. themes), please describe your installation procedure (clean, dirty, or describe when you wiped and/or formatted what).
*Please provide information, from which ROM or kernel you came.
Credits and many thanks to @woodman and @alias_ z3d in helping me to set up this OP.
First!!!
Perfect noc.jfcbs! After the i930x world, now the general version of your nice thread. I'm sure it will be a great addition to the XDA community. I hope a lot of members will read and remember your advices.
Background: Following some threads at XDA I’ve pretty early realised that quite a few bug reports, requests, and questions in regard to ROMs, kernels or applications are raised without sufficient information to allow (Recognised) Developers (RD), Recognised Contributors (RC), or other members to easily provide solid answers and recommendations or a possible fix. Everybody should remember even a highly professional member cannot read your mind.
Initially, I opened a thread with the same topic in regard to the device I use: The Samsung SGS3 LTE (GT-i9305). It’s accessible . If you already know that thread, I hope you don’t mind that I mostly copied and pasted.
Purpose: To provide some recommendations how to best phrase a request for support to possible ROM/kernel/applications issues in order to receive the most suitable answer and solution.
General recommendations:
Please read the XDA Forum Rules provided by @MikeChannon; a MUST READ for everybody who intends to post on XDA. Other MUST READ's I certainly recommend to everybody who wants to "breathe" what I believe the spirit of XDA is, are the following posts:
Forum Etiquette by @TheByteSmasher,
http://forum.xda-developers.com/show...postcount=2441 by @zelendel, and last but not least
http://forum.xda-developers.com/show...9&postcount=44 by @kyphur
Remember: Before you flash anything take a NANDROID backup or ensure you've an up-to-date one!
If you don’t know yet what’s hidden behind some of the expressions mentioned in the title of the following linked thread, just check it out: What is? Boot loader, custom ROMs, CWM, modem, kernel, flashing, rooting, ADB, baseband?? by @esimon311. Thanks to esimon311 for this great overview.
Guidance for useful modifications regarding some parts of your kernel can be obtained here: [GUIDE] Most up to date guide on CPU governors, I/O schedulers and more! by @Saber. Thanks to Saber for this great guide.
Before you post your issue or request, reboot at least once and try to replicate your problem. If it doesn't persist any longer the reboot might already have been the solution.
Read, read, and read again, read the OP (first post of each thread) and scan the respective thread. Use the search function of XDA. Remember: Make use of your friend – your favourite web-search engine. It does mean you have to read and study but I've no doubt you don't mind to do that for your device. Maybe, you'll find your required answer without having to post something.
A lot of OPs already contain hints how to solve commonly known issues.
Before you post in a ROM development thread, be sure not to run a custom kernel or Xposed. In case you use the latter, disable all Xposed modules and check if your issue still persists. Anyhow, if you’re using custom kernel or Xposed and you're convinced the issue is ROM related, you might post but mention the kernel and/or Xposed.
Last but not least: Don't ask what e.g. the best ROM, kernel or app is! All of them available at xda are great; however, each one of them has its different specification, capabilities, and pro's and con's depend on personal desire and expectations. The best one for you is the one, which meets your desire and expectation.
Before you post in a thread:
If you want to sell your car you probably achieve the better bargain the better (or more suitable) the portal is, in which you're offering it. I'm convinced you won't offer a car with the star at the bonnet on a webside covering military motorbikes.
Same applies to XDA. The more precise your post is going to fit into a thread or forum the faster and most likely better reply you're going to receive.
For this reason, I suggest you to exactly identify, in which of the 1000 fora or probably millions of threads to post. Prior to posting take you're time and study the following excellent guides and recommendations - all by @sd_shadow - to find the best and most reasonable place for your post.
[Guide] How and Where to Ask a Question on XDA
"Have Question about Posting?" in this post
[Index] of Help Threads (and Template)
When you post in a thread:
If available, post questions in Q&A threads (some threads have a dedicated Q&A section besides its development one) instead of the development thread. But if you have a solid bug report (never reported before, and your post is complying to all the required criteria provided below including all necessary info), you can post in a development thread.
Don't make a RD, RC or anybody else to read your mind. Don't have them to make assumptions – as soon as an assumption fails the whole solution is going to become void.
Please post your issue or request by using the English language as mentioned in the XDA rules to allow everybody to understand the post and hopefully to contribute, or at least to learn out of it. Don't be afraid if English isn't your native tongue – that's certainly the case for most of the xda users. A language barrier isn't an issue at XDA – as long as we all at least try to use the English language. Even if your English skills aren't too developed just use simple wording or a reasonable translator tool; nobody is going to blame you; however, try to be as precise and unambiguous as possible.
Always run a logging tool to be able to augment your post by a log file. Add the log as an attachment to your post or upload it into the cloud and provide the link in your post. Do not include the log into the text phrase of your post in order not to spam the thread. It doesn't matter, which logging tool you use but familiarise yourself with its use and where it saves the log. I'm personally e.g. using "Catlog" that saves logs to the internal storage. Alternatively use adb commands. Here is a [Tutorial] How To Logcat by @paxChristos. Thanks to paxChristos for this great tutorial.
If you're running (Ed)Xposed uninstall it, and take the log again (while Xposed is running, the log even states that it's useless because of Xposed).
Take screenshot(s) and attach them/it to your post. Don’t insert it/them into the “text box”. Before you take a screenshot, change your system language to English to allow everybody to understand the content of the screen.
Always provide exact and precise information about your issue. Write a description and, if possible, steps to allow for reproduction.
Unless the issue is only related to an application always provide exact and precise information about your device, the ROM, the kernel, your recovery, and specify the versions of the latter three. If you have issues with a theme, information regarding your ROM is certainly required. Occasionally information about your modem (or even bootloader) might also be helpful e.g. if you've problems with the RIL, mobile network or making phone calls. If you're on F2FS please mention.
If your issue or problem occurred immediately after you flashed a ROM* or kernel* or installed an application (incl. themes), please describe your installation procedure (clean, dirty, or describe when you wiped and/or formatted what).
*Please provide information, from which ROM or kernel you came.
Credits and many thanks to @woodman and @alias_ z3d in helping me to set up this OP.
First!!!
Perfect noc.jfcbs! After the i930x world, now the general version of your nice thread. I'm sure it will be a great addition to the XDA community. I hope a lot of members will read and remember your advices.