06-25-2010, 02:48 PM
I received a request for "Style Guidelines" for contributions to OALWrapper on the #penumbra IRC channel on freenode.
Right now there isn't any official guidelines. For right now just keep with the same style of the existing code, and make any suggestions of "clean" style guides. There are some commonalities that go through the code.. ie.. prefixing argument parameters with "a", class member variables with "m" and using a second letter to denote data type.
But really, any contributions that are clean and follow similarly with the existing coding style are perfectly fine.
When I have some time I may put up more proper guidelines, especially if we have a lot of contributers.
Right now there isn't any official guidelines. For right now just keep with the same style of the existing code, and make any suggestions of "clean" style guides. There are some commonalities that go through the code.. ie.. prefixing argument parameters with "a", class member variables with "m" and using a second letter to denote data type.
But really, any contributions that are clean and follow similarly with the existing coding style are perfectly fine.
When I have some time I may put up more proper guidelines, especially if we have a lot of contributers.