Opened 14 years ago
Last modified 3 years ago
#7486 assigned task
HowTo: become a contributor
Reported by: | mmadia | Owned by: | nobody |
---|---|---|---|
Priority: | normal | Milestone: | Unscheduled |
Component: | Documentation | Version: | |
Keywords: | Cc: | ||
Blocked By: | Blocking: | ||
Platform: | All |
Description
We should provide more in-depth documentation on what people can do, in order to become contributors.
One aspect could be a series on how to write code that conforms to the coding guidelines -- "Writing Code with Style", if you will.
It could be broken up into several sections/chapters/posts -- comments, loops, headers, whitespace, when to check for errors and bail early, structs, etc.
Maybe pointing to specific revision of code in svn, for real working examples of applying the code.
Change History (7)
comment:1 by , 12 years ago
Type: | enhancement → task |
---|
comment:2 by , 11 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
comment:4 by , 6 years ago
Hi,
I think the appropriate place for this content would be on the website:
https://www.haiku-os.org/development/getting-started
You can edit the website through github: http://github.com/haiku/website
comment:5 by , 4 years ago
Milestone: | R1 → Unscheduled |
---|
comment:6 by , 3 years ago
The current page seems pretty decent. What else should be added to close this ticket?
comment:7 by , 3 years ago
I'm working (on and off, been a bit busy with other things lately) into consolidating our developer documentation into a single "developer guide" providing all needed info: documentation about the internals of haiku, the build system, possibly the coding guidelines, the patch submission and review workflow, ...
I have barely started, at the moment I'm trying to just get the existing docs assembled together. I should upload my work so people can see what's going on and join in.
Remove this from my todo list.