GNOME Bugzilla – Bug 726115
Add HACKING
Last modified: 2016-03-31 13:22:07 UTC
This is a first sketch of a possible HACKME. Please let me know what you think about it. The intention of the first section is to provide easy to follow descriptions for bug submitters in the first section with all the trivial things so that everyone can submit a useful bug report. If you think this would fit better into the README, please tell me so.
Created attachment 271530 [details] [review] Add HACKME This HACKME contains information for people interested in * just filing a bug * getting started in developing boxes
Review of attachment 271530 [details] [review]: Firstly, the convention is to name the file HACKING so I'd just follow that convention. Good work apart from these small issues. ::: HACKME @@ +6,3 @@ + +This file is intended to help new developers to get started with developing +for gnome-boxes. Feel free to skip sections if you know what they are about. The name of the project is "Boxes" so unless you are talking about the package or command, just write it like that. When context is needed, write "GNOME Boxes". @@ +9,3 @@ + +Another good source for general information is: + https://wiki.gnome.org/action/show/Apps/Boxes Correct URL is: https://wiki.gnome.org/Apps/Boxes @@ +11,3 @@ + https://wiki.gnome.org/action/show/Apps/Boxes + +1. Bugtracker I think this section is for non-hackers too so it should be in README rather. Feel free to refer to README file from here. @@ +14,3 @@ +============= + +If you want to report bugs, please check on I'd write it as: "If you want to report bugs, please check if there isn't one already using the following URL: URL If one does not exist already, please file a new one. @@ +15,3 @@ + +If you want to report bugs, please check on + http://bugzilla.gnome.org/ * I would recommend providing a URL that leads to all (maybe only open?) bugs. You can use the advanced search feature to create the query and then copy&paste the URL. * If you want to put things on a newline, you want to create a new paragraph, i-e you want a blank line in between the lines. @@ +18,3 @@ +if the bug exists. If this is not the case, post it there. + +Be sure to provide as much useful information as you can: and empty line here would be nice. @@ +20,3 @@ +Be sure to provide as much useful information as you can: +* steps to reproduce your problem +* the error message, if there is one (in the UI and in the console) in the console -> on the console @@ +23,3 @@ +* a backtrace if the program crashes (See Appendix 1) +* debug messages if it makes sense (See Appendix 2) +* any modifications on the code you have done I wouldn't like people to provide random modifications. We should mention here that if you can provide a patch(es) to fix the issue, that would greatly increase the chances of issue getting fixed soon. @@ +32,3 @@ +============================== + +* read the CodingStyle.txt Capitalize first letter please since each bullet is not a continuation of any previous sentence. Also put a '.' at the end as these are supposed to be sentences. @@ +39,3 @@ +* the bugtracker has some quite cool features; use them! + * click on review to write comments to other or your patches or to comment + comments on these patches No need for it be in a sub-bullet. @@ +40,3 @@ + * click on review to write comments to other or your patches or to comment + comments on these patches +* dont be afraid about critics! The review process is probably going to be long. critics -> criticism :) @@ +41,3 @@ + comments on these patches +* dont be afraid about critics! The review process is probably going to be long. + * we dont dislike you! We really appreciate your work. No need for it be in a sub-bullet. @@ +57,3 @@ + http://blogs.gnome.org/tvb/2013/05/29/composite-templates-lands-in-vala/ + +4. Getting started with gnome boxes I don't think this section is needed here, maybe we should include this somehow in README instead.
Created attachment 271574 [details] [review] I dont think that the Getting Started With Boxes section is good for the README. This is definitly intended for developers, not for distributors, users or advanced users (the ones that dont develop but report bugs if they exist). All those will read the R
(In reply to comment #3) > Created an attachment (id=271574) [details] [review] > I dont think that the Getting Started With Boxes section is good for the > README. This is definitly intended for developers, No, this is intended for anyone wanting to know how to build and use Boxes or basically anyone at all who has access to the repo or source tarball and wants to know more about the package.
reminder: use the 'review' link to reply to inline comments.
Review of attachment 271574 [details] [review]: Looks really good otherwise. ::: HACKING @@ +46,3 @@ + +3. Getting Started With Boxes +============================= Now that I actually see the section, yeah this doesn't need to go into README. :) ::: README @@ +40,3 @@ +Reporting Bugs +============== I think most of this change belong in a separate patch. @@ +56,3 @@ +* debug messages if it makes sense (See Appendix 2) +* a fix if you have one (This greatly increases the chances of this issue + getting fixed soon. See HACKING, section 2 for how to provide a good patch) The parts about references to HACKING file (like this bullet) can be added as part of this (that adds HACKING file) patch. @@ +81,3 @@ + G_MESSAGES_DEBUG=Boxes gnome-boxes +If you want to run your jhbuild version, execute: + G_MESSAGES_DEBUG=Boxes jhbuild run gnome-boxes Might be good to also talk of `jhbuild shell` here so people know that they don't always have to do this each time they run Boxes.
Created attachment 271657 [details] [review] readme: Add Reporting Bugs So here comes the readme patch.
Created attachment 271658 [details] [review] Add HACKING And here is the HACKING one.
Review of attachment 271657 [details] [review]: almost there :) "Add Reporting Bugs" -> "Add 'Reporting Bugs' section'" ::: README @@ +83,3 @@ + G_MESSAGES_DEBUG=Boxes jhbuild run gnome-boxes +or + G_MESSAGES_DEBUG=Boxes jhbuild shell we'll need to say a bit more about this: "or start a shell under jhbuild environment: G_MESSAGES_DEBUG=Boxes jhbuild shell to be able to use simpler commands: gnome-boxes" Since you'll be making this chance, I'd also recommend adding empty lines before and after each commandline above to improve readability.
Review of attachment 271658 [details] [review]: Looks good
Created attachment 271700 [details] [review] readme: Add Reporting Bugs Add information about how to report bugs so that they may be adressed quickly.
Attachment 271658 [details] pushed as ec9094c - Add HACKING Attachment 271700 [details] pushed as da32125 - readme: Add Reporting Bugs