Modules... And the information in them

[Brandon8583]

OK, This is more of a rant than anyting else...

 

< rant >

 

Has anybody noticed that some of the Modules for OsCommerce just contain descriptions like "ttt" or "cool" instead of something useful? Or maybe an install.txt file that has "just copy, then your done!"?

 

While I do agree, after spending many hours of working on a module for everybody to use, the last thing you might want to do is spend another 10-60 minutes creating a description or an install.txt file. However, if you don't create a file that people can read about the module, understand how to install it, and contain a useful description on the modules page -- Your module will NOT go anywhere!

 

-- Butting in where I don't think I really should go... but......... -- :blush:

 

Granted, I am not the best PHP programmer, but I do have a decent background in the IT field. Here are a few things that I have learned in my time...

 

1.) Version Number - Umm... You should include this in all of your files that you can.

2.) What does your module do? - This is where people start having a problem... include a description of what your module does.

3.) What version of OsCommerce does your file work with? THIS IS A BIG ONE! I've seen so many modules that are mis-marked as 2.2-CVS... And, the next thing you know, your shopping cart is destroyed.

4.) A forum link if possible - Try to place a forum link in the install.txt file for people who are having problems.

 

Please -- for the people who aren't the best at PHP, or have no clue what they are doing, make the files useful!!! It will save you a headache or two from trying to answer the emails that may just flood your inbox if somebody is having a problem!

 

< / rant > :blush:

[♥monte22]

Screenshots of modules with visual changes would be nice. ;)

[kwalker]

Brandon,

 

I couldn't agree with you more. I just now installed a contrib, without me doing any changes to the store before hand, except for the basic name, address, info like that... but the contrib doesn't work. If it does work, it isn't working for me.

 

I've also noticed that there is no info about what to do in case I run into a problem, who to contact, where to contact or anything along that line. I would only image that since the email was listed in the readme file, I could email them/him/her/ directly.

 

It would also be nice if they can explain the FAQ about their contrib. I know they get questions about them... so they should include them in a file, so they don't have to answer the same question 1,000,000,000 times.

 

If any moderator or so is reading this, this thread really belongs in the "suggestions" area of this forum. These suggestions are something that the contributors should practice.

 

 

Kevin

[Brandon8583]

Thanks Kevin & Dubz... I agree. There should be some type of requirements for posting contributions. I am really surprised that with as many amazing programmers that are creating these mods, that they don't include some of the important things.

 

I know that the programmers are also very busy people and that they may not have all of the time in the world, but at the same time, I understand the requirements. I came from a very BIG I.T. company before, and if we didn't have the details, you could expect the documentation team coming after you in the parking lot....

 

If anybody else has suggestions on what information should be posted in the contributions, place it in this thread.

 

Thanks, and Happy Programming!

[MarcoZorro]

Firstly I think you need to understand that these contributions are created from work that people do because they needed it for their own use.

 

Many of the contributions are created by people that dont have any programming knowledge before they start so dont expect code that works in all cases.

 

Complaining about lack of information etc doesnt get anywhere and asking or forcing contributors to do things in a certain way will stop people from contributing.

 

If you find a contribution that doesnt have good documentation then fix it. Problem solved :thumbsup: If a contribution doesnt work and you need it then fix it yourself or pay a developer to fix it for you. Then add the new contribution (with the documentation you did of course ;) ) to the contributions section :thumbsup:

 

The comment about who to contact for supoort is also a non starter. The contributor doesnt have any requirement to support a contribution. If they wanted to then they will provide the details on how to contact them. If a contribution isnt supported then dont use it :-"

[GraphicsGuy]

Brian pretty well captured my thoughts on this too. While I agree that some of the descriptions are rediculous (i.e. "ttt"), and it would be nice if all contributions were well documented, I would hate to see restrictions and requirements diminish the diverse functionality available with minimal effort.

 

It is important to remember that the contributions are just that, contributions from the community to the community. They are not commercial products and most aren't even freebies thrown out there by commercial interests as advertising.

 

And as Brian said, and I have said in other threads, anyone can document a contribution and add it to the contribution. It would be more beneficial to the community if those who are incensed at the lack of documentation and screenshots would pick out one or two, study it and do the documentation and screenshots. Pretty soon, they would all be well docuemntated, complete with screenshots. That is the way a community works best - working together and sharing the work load.

[kwalker]

I agree with both of you. 100%.

 

With that said by you GraphicsGuy, I know I can really help. I wasn't sure that you can do some of the "public domain" modifications.

 

I'll make a difference, and I'll help out, for all of you that "contribute your valued time" to any community. You all have made me think and re-think, and I'm glad.

 

Brian & GraphicsGuy, you couldn't have stated it any better than you did. I appreciate your input.

 

 

 

Kevin

[Brandon8583]

I agree with both of you. 100%.

 

With that said by you GraphicsGuy, I know I can really help. I wasn't sure that you can do some of the "public domain" modifications.

 

I'll make a difference, and I'll help out, for all of you that "contribute your valued time" to any community. You all have made me think and re-think, and I'm glad.

 

Brian & GraphicsGuy, you couldn't have stated it any better than you did. I appreciate your input.

Kevin

 

Hrmm... Didn't mean to upset anybody, but seeing as I already have....

 

What really irritates me is that this post was taken as if I was yelling at the people who created the modules... I'm not!. Let me clarify what has been taken out of context:

 

First (Again)- Thank you everybody who has posted contributions. Thank you for your time and your hard work.

 

Second: The initial post that I created was, more the less, for suggestions. Just trying to help out other people and saving a few extra minutes of debugging. Take it as you wish.

 

Third: The use of "Requirements" on my behalf was incorrect - I'm sorry. I understand that I upset a few people.

 

 

Don't take this the wrong way, as I again, am not trying to get anybody upset. The intial reason for the post was to maybe... just maybe... point a few people in a direction that could help too.

Unfortunatly, I got slapped in the process.

 

Good luck to everybody on your ventures...

[GraphicsGuy]

Hrmm... Didn't mean to upset anybody, but seeing as I already have....

 

What really irritates me is that this post was taken as if I was yelling at the people who created the modules... I'm not!. Let me clarify what has been taken out of context:

 

First (Again)- Thank you everybody who has posted contributions. Thank you for your time and your hard work.

 

Second: The initial post that I created was, more the less, for suggestions. Just trying to help out other people and saving a few extra minutes of debugging. Take it as you wish.

 

Third: The use of "Requirements" on my behalf was incorrect - I'm sorry. I understand that I upset a few people.

 

 

Don't take this the wrong way, as I again, am not trying to get anybody upset. The intial reason for the post was to maybe... just maybe... point a few people in a direction that could help too.

Unfortunatly, I got slapped in the process.

 

Good luck to everybody on your ventures...

 

You are most certainly welcome to offer ideas to help improve the community. I hope you will continue to be an interactive member of the community. And when it comes to those few contirbutions that just do the "ttt" or "cool" descriptions, I agree that they are useless and annoying. It was the idea of imposing restrictions that bothered me mainly and you have addressed that.

[Mediajuggle]

well here's my two cents....

 

it would be nice if whenever someone makes a change to a contribution, that they post the FULL INSTALLATION.

 

It really is a pain to have to download fix A and fix b for contribution 1.0