Jump to content



Latest News: (loading..)

* * * * * 1 votes

How To Make Contributions


  • Please log in to reply
48 replies to this topic

#21   charleyshipman

charleyshipman
  • Members
  • 48 posts
  • Real Name:Charles Shipman

Posted 27 April 2004 - 12:48 AM

Since there is some comment about what would be good to enhance contributions, let me add my penny's worth:

Even though it is a lot of work for the contributor, all contributions should be submitted with a complete list of "find this" then "replace with or add that" changes to each and every module to which it applies.  The reason for this is that most contributions seem to be written for an unmodified system.  For modified systems, installation by simply copying various php modules does not work.  And, in my case at least, my system is quite modified (I flail around a lot.)

There are some modules I'd like to include, but the effort to try to figure out what was changed, particularly since I'm not sure of exactly what the starting point was (although, usually it is MS2.2 or MS2.1) is prohibitive.

CharleyShipman

#22   paulm2003

paulm2003
  • Validating
  • 684 posts
  • Real Name:Paul Math
  • Location:Netherlands

Posted 27 April 2004 - 07:46 AM

stevel, on Apr 22 2004, 09:32 AM, said:

Yes, you can go back and edit your post, but that looks awkward.

What would be cool is if the submission of a contribution automatically created the announcement topic and support topic, and inserted appropriate links to each.
Don't know if awkward is the right word, but editting the post to link the contri, annoucement and support thread to each other indeed is a real pain. Even almost impossible sometimes, when the forums are a "bit" slow.

I think automatic linking/setup is a must, at least from the contrib download to the to the support thread.

#23   paulm2003

paulm2003
  • Validating
  • 684 posts
  • Real Name:Paul Math
  • Location:Netherlands

Posted 27 April 2004 - 07:52 AM

charleyshipman, on Apr 26 2004, 08:48 PM, said:

There are some modules I'd like to include, but the effort to try to figure out what was changed
doing a file compare to your "starting point" would give you this info I suppose.
(and after checking carefully it's all correct, you can upload that yourself as an update to the contribution if you think it's usefull for others too)

#24   cyberphool

cyberphool
  • Members
  • 16 posts
  • Real Name:David

Posted 03 August 2004 - 11:25 AM

I'd like to add what is important for me regarding the contributions.

(apart from coding standards and documentation explaining how to implement them)

I thinks it's really important to be able to rate contributions, there are some that are very similar and it's difficult to choose between them.  I don't have the time to try a contribution, get it to work and then uninstall it without too much fuss.

Secondly, where possible, it would be great to see a screenshot.  It really helps to see what the contribution is aiming to do, and it often gives an indication of the level of quality of the contribution itself.


Regards,


David

#25   mrsC2003

mrsC2003
  • Members
  • 131 posts
  • Real Name:Kelley
  • Location:Pittsburgh PA

Posted 31 August 2004 - 05:03 AM

Reading over this thread I have seen some really good suggestions for contributions. I must agree that a screen shot does wonders to make sure that everything is how it is intended to be. A list for compare and replacing of code has been great to find in many contributions. Even pages that have been done from a clean install and put into their respective folders helps.

The submission and forum linkage is a brilliant idea, as well as rating and download count.

Here I think so many will agree with me.

The contribution section needs cleaned out !!!!!

Contributions that are years old that are already a part of OSC, are clogging the contribution sections.

Contributions that have been updated version by version with old versions left on the list. Or fixed bugs that don't even tell you what version the fix is for till you download and open it up (wasted time and bandwidth)

Double files in some of the newer contributions.

The contribution section needs more of a break down of the types of contributions.

for example

Buttons ... Make a list just for buttons

Admin section ..... listing for admin section and a break down of sub cats.

If the contribution section was ran like the osc cart it would be a wonderful thing.

Just my 2 cents worth

Kel
I live in my own little world. But it's OK. They know me here.

#26 ONLINE   Mark Evans

Mark Evans

    Code Monkey Rockstar

  • Core Team
  • 2,515 posts
  • Real Name:Mark
  • Gender:Male
  • Location:Behind you :-P

Posted 19 September 2004 - 05:21 PM

Some guidelines for contributions are now available in the KB

http://www.oscommerce.info/kb/osCommerce/Tips_and_Tricks/195
Mark Evans
osCommerce Monkey & Lead Guitarist for "Sparky + the Monkeys" (Album on sale in all good record shops)

---------------------------------------
Software is like sex: It's better when it's free. (Linus Torvalds)

#27   Malawi

Malawi
  • Members
  • 19 posts
  • Real Name:Trygve Lillefosse
  • Location:Norway

Posted 21 December 2004 - 02:09 AM

It should pe possible to report contributons to be deleted.

In some contributions there are questions or remarks posted as updates to the main contribution.
Malawi, The Fisher King
AKA Trygve Lillefosse

#28   medvid

medvid
  • Members
  • 1,210 posts
  • Real Name:Medvid

Posted 11 March 2005 - 02:14 PM

I've looked at the KB page on contributions and I've read this thread.  Neither answers my next question.

I have been updating the Who's Online Enhancement contrib.  Some people have posted problems with the contrib.  Some of these problems are in the code that was from the original MS 2 code base.  Most of them deal with site configuration, not install mistakes.

I am not able to test every combination of configuration.  So, I'd like to have my newest version beta tested, especially be the people who have current problems to see if the new version fixes them.  I have posted a suggestion for beta testing to the WOE support forum and received no takers.  I could post it to the contribs but I really only want people to use it who understand it's a beta.  Plus, I have a couple more new features to add before I call the version done.

Given that, should I post it as a contrib?  Marked as a beta with a warning?  Beg some more for beta testers?  Any possibility of a Developers contrib section for beta contribs?

Thanks,
Ed
Answers to osCommerce's most persistent questions!  Tips & Tricks | Configuration | Common Problems.
Seek and ye shall find Contributions.
My Contributions
My Blog

#29   John Holmes

John Holmes
  • Members
  • 128 posts
  • Real Name:John Holmes

Posted 11 March 2005 - 02:20 PM

Honestly if no one is responding for beta testers in the forum the only thing I could really suggest if to post it in the Contributions section and call it say you already have version 2.2 out.  I would say version 2.2.1 Beta.

Remember when you ask for help a lot of people are takers not givers.  Only the true osC enthusiasts will come out to help to benefit the whole and not themselves.

So I say post it in the Contributions section even if it's a beta.  Who knows?  Maybe a beta tester will find faults and make corrections in conjunction with your findings.

#30   GwilliamP

GwilliamP
  • Members
  • 157 posts
  • Real Name:Paul
  • Gender:Male
  • Location:North Devon - UK

Posted 16 May 2005 - 07:20 AM

Support

Could I suggest the following procedure?

1 - Before a contribution is posted, a support thread should be created called "[Contribution_Name] Support".

2 - Include a 'link' to the thread in the readme.txt/documentation.

3 - At the time of posting the new contribution a link to the thread should be included.

Maybe a new Subforum could be created to contain these threads?

I am new to this and am having great difficulty finding threads relating to support issues for the few contributions I have started to use. Only one has anything close to the above.

#31   enigma1

enigma1
  • Members
  • 8,206 posts
  • Real Name:Mark Samios

Posted 09 July 2006 - 05:47 PM

ok to get around the chicken and the egg thing with the forum and contribution pages, I do this:

1. Create the forum support thread which will generate a link.
2. Upload the contribution and add to the description box the forum link.
3. Edit or add a post to the forum thread for the contribution link.

If you do the process within few minutes you should endup with a single post on the forum showing the contribution link while the contribution page will include the forum support thread so other people can easily find it.

#32   asdqert

asdqert
  • Members
  • 16 posts
  • Real Name:Joost

Posted 13 March 2007 - 01:31 PM

Little note on this should be the Contr < - > Forum connection, not always there's a clear link to the support section. Quite a miss.

#33   sofaking

sofaking
  • Members
  • 81 posts
  • Real Name:Michael Hernon
  • Gender:Male
  • Location:Scotland

Posted 16 July 2007 - 02:54 PM

Can I ask who is responsible for the tidying up of the contributions?

I ask I have made 3 or 4 contributions to the 1 section!!

I discovered one problem, fixed the code then contributed it.

Then discovered another problem fixed that code then contributed that version..
..
....then........

Is there no way for the original user to remove their contribution or alternativly a moderator for the contributions
A supreme being that you can say - delete this one please?

Cheers,

Michael.

#34   nikikelly

nikikelly
  • Members
  • 45 posts
  • Real Name:nicole kelly

Posted 13 April 2008 - 07:57 PM

How exactly does one make use of a diff file?  Do I need to use Beyond Compare or Diffdog or something?  I can't for the life of me find any documentation on how to merge the changes found in a diff file with my current version of a page....anyone?  Please help!

View Postzzfritz, on Feb 20 2003, 03:40 AM, said:

Besides coding conventions, there is also an issue regarding how contributions should be packaged.  Brad Waite and I have just had a private colloquy about this, on a contribution in which we collaborated. He preferred to post diff files, while I had posted replacement files in nested directories.  Each package appeals to a different audience, so I proposed to release the contribution both ways simultaneously.  
Of course all contributions should be accompanied by a readme.txt or install.txt, which clearly describes the function, content and structure of the contribution, then lists steps for its installation.  The contributor should also note the compatibility constraints (e.g., works only with checkout system post 20021101) or certification (e.g., tested with MS1).
Let me take this opportunity to stimulate some discussion on conventions (or at least suggestions) for packaging contributions.


#35   kakindo

kakindo
  • Members
  • 1 posts
  • Real Name:Charles Byaruhanga

Posted 15 July 2008 - 07:47 AM

I am new to oscommerce and php, and I would like to create add ons, do you have a guide that can help me please

#36   Jack_mcs

Jack_mcs
  • Members
  • 25,303 posts
  • Real Name:Jack York
  • Gender:Male
  • Location:Michigan

Posted 15 July 2008 - 11:43 AM

Download and, preferably, install a number of contributions. You will gain an understanding of what is needed. But, in my opinion, your contribution should contain the following:

- complete instructions - including file change instructions for a standard shop
- include changed files, if possible
- stay away from html instruction files
- don't include changes that have nothing to do with the contribution
- GPL license file (required)

You should also have tested the contribution in both MS2 and RC2 shops, or state that your contribution will only work with one. And if you upload a new version, upload a full version.

Jack

#37   wemseo

wemseo
  • Members
  • 118 posts
  • Real Name:Norbert Harms

Posted 05 July 2009 - 02:26 PM

OH MY DEAR LORD

I have no idea how to cook but I have a restaurant and would like the world to come to my kitchen to eat (and get sick)

ARE YOU FOR REAL?





View Postwider, on Jan 22 2003, 03:52 PM, said:

Dear Fritz,

I certainly appreciate your concerns about modularity, stability and the upkeep of conventions. It would in deed leed to a better system.

On the other hand, the emphasis on the 'perfect' coding standard might encourage less experienced developers and, most of all, users to make their spontaneous ideas available to the community.

I, for this matter, can hardly write php, never mind fully understand the tep-methods. But I'm a user with a clear idea of how certainl shop functions will have to work. If I ever make a proper contribution, it probably won't be spotless. Should I not make it available?

Perhaps, there could be sort of a 'mentoring group' where beginners can post their contributions for polishing up. More experienced developers can then comment or contribute some corrections. Then, the code will be fantastic and the community still benefits from the maximum base of ideas.

In the end, I'd rather have a sloppy solution to an urgent problem, than none at all.
But, again I am NOT IN TOTAL disagreement.
Thanks!

:wink:


#38   dvharrison

dvharrison
  • Members
  • 326 posts
  • Real Name:Deb
  • Gender:Female
  • Location:Essex, UK

Posted 30 September 2009 - 11:42 AM

I have no idea if this is the appropriate place to suggest it (obviously moderators - remove this post if I have posted in the worng place), but wouldn't it be a good idea to have an RSS Feed on contribution pages so its easier to keep track of when updates are made instead of having to physically look (which lets face it - can be VERY time consuming).

I would love to hear your take(s) on this

Edited by dvharrison, 30 September 2009 - 11:42 AM.

Debbie Harrison

#39 ONLINE   Jan Zonjee

Jan Zonjee

    Governor of Peace

  • Core Team
  • 7,042 posts
  • Real Name:Jan Zonjee
  • Gender:Male
  • Location:the Netherlands

Posted 03 October 2009 - 06:51 AM

View Postdvharrison, on Sep 30 2009, 01:42 PM, said:

wouldn't it be a good idea to have an RSS Feed on contribution pages so its easier to keep track of when updates are made instead of having to physically look (which lets face it - can be VERY time consuming).
There already is an rss feed linked to on the contributions page:
Posted Image New Entries

http://www.oscommerce.com/oscommerce_contributions.rdf


#40   ecartz

ecartz
  • Community Sponsor
  • 1,956 posts
  • Real Name:Matt
  • Gender:Male

Posted 03 October 2009 - 01:59 PM

View PostJan Zonjee, on Oct 3 2009, 02:51 AM, said:

There already is an rss feed linked to on the contributions page:
When I read her post, I thought that she was asking for multiple RSS feeds, one per contribution, so that it would work more like Contribution Tracker does.  

The main RSS feed is noisy, telling you about many contributions that don't matter to you.  A more targeted feed or feeds would allow you to watch just the contributions that you are actually using.  The current feed is good for finding new contributions to install (albeit with a high noise to signal ratio), but the desire is for updating currently installed contributions with the latest bugfixes and security patches.
Always backup before making changes.