New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Features/add coding guidelines #34

Merged
merged 7 commits into from Dec 16, 2015

Conversation

Projects
None yet
3 participants
@gplssm
Copy link
Contributor

gplssm commented Dec 16, 2015

Missing parts of developer notes added to documentation based on Developing Rules from vernetzen-Wiki. It is just an automatic translation by pandoc. So it still has formatting problems. Please help to improve formatting. Afterwards a responsible person can do the merge into dev.

gplssm added some commits Dec 16, 2015

pandoc translation target language changed to GitHub markdown
There are still a lot of awful formattings, but it's the best automatic translation result I could get.

@gplssm gplssm added this to the December 2015 release milestone Dec 16, 2015

@uvchik uvchik added the help wanted label Dec 16, 2015

@gplssm

This comment has been minimized.

Copy link
Contributor Author

gplssm commented Dec 16, 2015

Thanks for cleaning up. Looks nice now! Ready for merging?

@uvchik

This comment has been minimized.

gplssm added a commit that referenced this pull request Dec 16, 2015

@gplssm gplssm merged commit 22f4f70 into dev Dec 16, 2015

@gplssm gplssm deleted the features/add_coding_guidelines branch Dec 16, 2015

@ckaldemeyer

This comment has been minimized.

Copy link
Member

ckaldemeyer commented Dec 17, 2015

I just fixed some typos. One point:

"Functions/Method: Name it after what they do: use verbs (get_wind_speed, set_parameter)"

I remember Günni having some issues with the get/set-naming of methods but don't remember the reason anymore. Maybe we should discuss this as this is a pretty common part of any produced code.

@gnn : What was the initial reason for your objection?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment