Hi All,

This adds two guidelines to CONTRIBUTING.md following on from the coding convention discussion that Ben started (and which is still ongoing) (thanks, Ben!):

- Separate function declaration type and name to two lines - Tabs are 4 spaces

Since this is intended to become the documentation, it is written as a fait accompli, but I of course welcome discussion.

Cheers, Alistair

On Sun, 6 Jan 2019 at 08:09, akgrant43 notifications@github.com wrote:

[ci skip]

---

You can view, comment on, or merge this pull request online at:

https://github.com/OpenSmalltalk/opensmalltalk-vm/pull/350

Commit Summary

CONTRIBUTING.md: Add some style guidelines

File Changes

M CONTRIBUTING.md (39)

Patch Links:

https://github.com/OpenSmalltalk/opensmalltalk-vm/pull/350.patch https://github.com/OpenSmalltalk/opensmalltalk-vm/pull/350.diff

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

nicolas-cellier-aka-nice commented on this pull request.

+C function declarations should have the type on one line and the +function name and parameters on the following line, e.g.: + +``` +static int +convertCopy(char *from, int fromLen, char *to, int toLen, int term) +``` + +This facilitates searching for function definitions by searching for the +name at the beginning of the line. + + +## Tabs are 4 spaces + +The heading says it all.

A side note: the legacy platforms/win32 is using these settings:

8-space tabs stops 2-space indent

I don't want to create massive change of ownership for fixing that... https://stackoverflow.com/questions/4112410/git-change-styling-whitespace-wi...

No worries at all, there's no rush. Have a great weekend...

Fabio

There haven't been any more comments for a couple of weeks. I'm not particularly happy with the section on tabs vs spaces, however it's always easier to criticise someone else's work than start with a blank slate, so take this as inspiration! :-)

[ci skip]

Reopened #350.