Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
bugzilla:dosanddonts [2023/10/12 06:32] – Hmmph. The visual bug affecting anchors is invisible when using the Preview feature of MoinMoin. Let's try, again, to work around … GrahamPerrinbugzilla:dosanddonts [2023/10/14 08:40] (current) – Consistency: remove superfluous leading white space from list items (bullet points). GrahamPerrin
Line 13: Line 13:
   * [[https://bugs.freebsd.org/bugzilla/query.cgi|search]] first — avoid duplication.   * [[https://bugs.freebsd.org/bugzilla/query.cgi|search]] first — avoid duplication.
   * before submitting (saving), double-check the 'Description' field   * before submitting (saving), double-check the 'Description' field
-    * you cannot preview what will become your opening comment — [[https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=250699|bug 250699]] +    *  you cannot preview what will become your opening comment — [[https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=250699|bug 250699]] 
-    * saved commentary can be neither edited, nor deleted — [[https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=191677|bug 191677]]+    *  saved commentary can be neither edited, nor deleted — [[https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=191677|bug 191677]]
     * if the description involves an attachment that aims to patch ''%%doc%%'' (documentation), ''%%ports%%'', or ''%%src%%'' ([[/Base|base]]), write it as you would a good commit message. A ports example:     * if the description involves an attachment that aims to patch ''%%doc%%'' (documentation), ''%%ports%%'', or ''%%src%%'' ([[/Base|base]]), write it as you would a good commit message. A ports example:
  
Line 63: Line 63:
     * **Note**: maintainer approval requests must include the maintainer's e-mail address as specified in the port's Makefile     * **Note**: maintainer approval requests must include the maintainer's e-mail address as specified in the port's Makefile
   * post a comment if you're unable to provide requested feedback (eg. due to lack of time or even loss of interest)   * post a comment if you're unable to provide requested feedback (eg. due to lack of time or even loss of interest)
-  * be polite — say //please//, //thank you//, and so on+  *  be polite — say //please//, //thank you//, and so on
   *  be patient   *  be patient
     * the 'Following Up' section of [[https://freebsdfoundation.org/freebsd-project/resources/how-to-submit-a-bug-report/|How to Submit a Bug Report]] describes periods during which there is //no visible// activity on a report     * the 'Following Up' section of [[https://freebsdfoundation.org/freebsd-project/resources/how-to-submit-a-bug-report/|How to Submit a Bug Report]] describes periods during which there is //no visible// activity on a report
     * //invisible// activities include thought processes, and other things that are not easily expressed in plain text     * //invisible// activities include thought processes, and other things that are not easily expressed in plain text
     * if //visible// work towards a fix takes longer than you would like, remember that most work is volunteered, and that each person contributing (including upstream) will have priorities that do not match your own.     * if //visible// work towards a fix takes longer than you would like, remember that most work is volunteered, and that each person contributing (including upstream) will have priorities that do not match your own.
-  *  remember the [[https://en.wikipedia.org/wiki/Golden_Rule|Golden Rule]]+  *   remember the [[https://en.wikipedia.org/wiki/Golden_Rule|Golden Rule]]
     * treat others as you would like others to treat you — what you wish upon others, you wish upon yourself     * treat others as you would like others to treat you — what you wish upon others, you wish upon yourself
     * apply the rule equally in areas that run parallel to Bugzilla, such as [[https://github.com/freebsd/|the FreeBSD Project organisation in GitHub]].     * apply the rule equally in areas that run parallel to Bugzilla, such as [[https://github.com/freebsd/|the FreeBSD Project organisation in GitHub]].
Line 95: Line 95:
 Please, do not: Please, do not:
  
-  * use the //patch// or //patch-ready// keyword +  *  use the //patch// or //patch-ready// keyword 
-  * use **[TAGS]** like [MAINTAINER], [UPDATE], [EXP-RUN] and [PATCH] in issue titles +  *  use ''%%[tags]%%'' such as ''%%[maintainer]%%'', ''%%[patch]%%'', or ''%%[update]%%'' in the summary line (the title) 
-    * [NEW PORT] in title for new port submissions **is OK** for now. +    * ''%%[exp-run]%%'' and ''%%[new port]%%'' //are// OK, for now 
-  * use an **empty summary**. +  * use an **empty summary** 
-  * use **foo is broken** as a summary. +  * use **foo is broken** as a summary 
-  * add just **me too** comments. DO add comments if you have additional information.+  * add just **me too** comments. DO add comments if you have additional information
   * **bump** issues (add "bump" or "any progress?", etc)   * **bump** issues (add "bump" or "any progress?", etc)
     * instead, //do// update issue metadata to bring it up to date     * instead, //do// update issue metadata to bring it up to date
-    * //do// include comments if they clarify what is now needed to progress the issue. +    * //do// include comments if they clarify what is now needed to progress the issue 
-  * **speculate** on what an issue/bug is caused by. Stick to facts and evidence.+  * **speculate** on what an issue/bug is caused by. Stick to facts and evidence
   * **fiddle with Attachment** mime types   * **fiddle with Attachment** mime types
-  * cancel/remove a flag by setting its value to empty/undefined. +  * cancel/remove a flag by setting its value to empty/undefined 
-  * **paste large logs** or file contents in comments (DO: use //Attachments//). +  * **paste large logs** or file contents in comments (DO: use //Attachments//) 
-  * include poudriere/QA logs as attachment unless specifically requested. +  * include poudriere/QA logs as attachment unless specifically requested 
-  * **wait for others** to add or update issue fields. Many hands make light work.+  * **wait for others** to add or update issue fields. Many hands make light work
   * add a //Comment// if the change made is self-explanatory. Example:   * add a //Comment// if the change made is self-explanatory. Example:
  
Line 122: Line 122:
   * try to **game the system**. Example: by adding easy patch-ready or setting approved flags   * try to **game the system**. Example: by adding easy patch-ready or setting approved flags
   * use maintainer-**feedback** flag to declare approval of a patch. (DO use the maintainer-**approval** flag)   * use maintainer-**feedback** flag to declare approval of a patch. (DO use the maintainer-**approval** flag)
-  * **combine or include patches for multiple ports** in the same issue, unless they *must* be committed together.+  * **combine or include patches for multiple ports** in the same issue, unless they *must* be committed together
     * instead, create separate issues and have them //Depend on// or //Block// each other as appropriate     * instead, create separate issues and have them //Depend on// or //Block// each other as appropriate
   * change the status of an issue to past Open (eg: In Progress) unless and until it has a real (not a team or mailing list) Assignee   * change the status of an issue to past Open (eg: In Progress) unless and until it has a real (not a team or mailing list) Assignee
     * this criterion does not suit all workflows, should probably be mentioned at [[KubilayKocak/Bugzilla/ProblemsAndIdeas]]     * this criterion does not suit all workflows, should probably be mentioned at [[KubilayKocak/Bugzilla/ProblemsAndIdeas]]
   * close (resolve) an issue until all commits/changes have been made (including MFC's and MFH's)   * close (resolve) an issue until all commits/changes have been made (including MFC's and MFH's)
-  * use **external URL's** in comments, as they can become stale/disappear.  +  * use **external URL's** in comments, as they can become stale/disappear 
-    * instead, include URL contents as attachments with the URL as the Description, or in the URL or See Also fields. All information should be self-contained in the issue. +    * instead, include URL contents as attachments with the URL as the Description, or in the URL or See Also fields. All information should be self-contained in the issue 
-  * use the same PR to do multiple unrelated things. E.g: if while working on a **fix** for a port a new version is released, create a new PR to update the port. +  * use the same PR to do multiple unrelated things. E.g: if while working on a **fix** for a port a new version is released, create a new PR to update the port 
-  * include **Signatures** at the bottom/end of issue reports or comments. +  * include **Signatures** at the bottom/end of issue reports or comments 
-  * be unnecessarily verbose. +  * be unnecessarily verbose 
-  * create, or engage in, **argument** +  * create, or engage in, argument 
-    * instead, be factual.+    * instead, be factual 
 +    * disagreement is natural — when a technical difference of opinion arises, do, please, build and maintain mutual respect (remember the [[#goldenrule|Golden Rule]])
   * be abusive, or use abusive language — commentary is [[#immutable|immutable]].   * be abusive, or use abusive language — commentary is [[#immutable|immutable]].
  
  • bugzilla/dosanddonts.1697092358.txt.gz
  • Last modified: 2023/10/12 06:32
  • by GrahamPerrin