Add document on how to submit patches #204
Conversation
Copy the file `SubmittingPatches` from the git project at the revision below. ``` $ git describe --tags v2.11.0-rc1 ```
pmenzel
force-pushed
the
add-document-on-how-to-submit-patches
branch
from
474887e
to
8bb1972
Compare
|
@all, please comment this suggestion. |
|
Paragraphs "Decide what to base your work on" and "GitHub-Travis CI hints" don't apply here, do they? |
This paragraph doesn’t apply to us, so remove it.
Although useful, we are not there yet, so remove the paragraph.
GitHub support Markdown, and it is pretty popular, so use it here too.
|
@donald, I deleted the paragraphs, and converted the document to Markdown markup language. |
| @@ -0,0 +1,122 @@ | |||
| Here are some guidelines for people who want to contribute their code | |||
| to this software. | |||
There was a problem hiding this comment.
"this software" ? A bunch of bee-files isn't software. 'bee-files' is not a software project but a collection of bee-files.
also I find the name SubmittingPatches misleading. "Hey, your bee-file is buggy, take this patch and fix it".
There was a problem hiding this comment.
I totally agree. Looking at the userbase, I’d argue the document is good enough for a start, and can be improved over the time.
These paragraphs talk about descriptive text not about commit separation.
The section was reduced to its header, so we make the section into a normal paragraph
We are talking about commits here now, not just about description. At the same time make the first occurence of "the commit" to "each commit" so readers don't get irritated by the wrong grammatical number.
|
ping |
|
Looks good to me from my side. Despite there are also commits from myself, I’ll merge it, as there has been enough time to review this. |
Copy the document
SubmittingPatchesfrom the git project, and adapt it to our needs.