<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][14008] trunk/docs/contributor: Documentation: explain how to report bugs to new contributors</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/14008">14008</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/14008","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-08-19 19:37:13 +0000 (Mon, 19 Aug 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Documentation: explain how to report bugs to new contributors
Props vapvarun, emaralive.
Closes https://github.com/buddypress/buddypress/pull/360</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkdocscontributorREADMEmd">trunk/docs/contributor/README.md</a></li>
<li><a href="#trunkdocscontributormanifestjson">trunk/docs/contributor/manifest.json</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunkdocscontributorcodereportbugsmd">trunk/docs/contributor/code/report-bugs.md</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkdocscontributorREADMEmd"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/docs/contributor/README.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/contributor/README.md 2024-08-19 18:57:51 UTC (rev 14007)
+++ trunk/docs/contributor/README.md 2024-08-19 19:37:13 UTC (rev 14008)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,7 +17,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> Testing BuddyPress [beta](https://buddypress.org/tag/beta/) releases for issues is critical to developing the software and ensuring its quality. It is the key to a safe upgrade for you and every BuddyPress users. It’s also a meaningful way for anyone to contribute — whether you have coding experience or not. If you think you’ve found a bug, it’s a good idea to search Trac first to see if a ticket already exists that you could contribute to. Otherwise, go ahead and open a [new ticket](https://buddypress.trac.wordpress.org/newticket)!
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-Never written a bug report? The [WordPress Core Contributor Handbook](https://make.wordpress.org/core/handbook/) has an excellent guide on what to do [before you report a bug and how to write a good bug report](https://make.wordpress.org/core/handbook/testing/reporting-bugs/#before-you-report-a-bug).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+Never written a bug report? This documentation page will guide on what to do [before you report a bug and how to write a good bug report](./code/report-bugs.md).
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> ## Translate BuddyPress
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunkdocscontributorcodereportbugsmd"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/contributor/code/report-bugs.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/contributor/code/report-bugs.md (rev 0)
+++ trunk/docs/contributor/code/report-bugs.md 2024-08-19 19:37:13 UTC (rev 14008)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,76 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# Reporting Bugs
+
+The BuddyPress community relies on contributions from people like you to grow stronger every day. As more users test and use BuddyPress, we receive more bug reports, feature suggestions, and enhancement ideas. The BuddyPress Team need these feedbacks to carry on improving the software.
+
+This guide provides helpful information on how to report bugs or request features and how you can get involved into fixing these.
+
+## Overview of Bug Reporting and Resolution
+
+1. **Identifying a Bug**: A user finds a bug in the core of BuddyPress (not in a Theme or Plugin).
+2. **Verifying the Bug**: The user verifies that it is a bug, potentially by posting on our [support forums](https://buddypress.org/support/).
+3. **Reporting the Bug**: If confirmed as a bug, the user submits a ticket to the [BuddyPress bug tracker](https://buddypress.trac.wordpress.org/newticket).
+4. **Bug Confirmation**: A BuddyPress developer confirms the bug and marks it as valid.
+5. **Fixing the Bug**: A developer (potentially you) fixes the bug, creates patch files, and uploads them to Trac (a GitHub Pull Request can alternatively be made on our [GitHub repository](https://github.com/buddypress/buddypress)).
+6. **Patch Review**: Other developers review the patch to ensure it fixes the bug without causing other issues.
+7. **Patch Commitment**: A BuddyPress core developer commits the patch to the core code for inclusion in the next release.
+
+## Detailed Steps for Bug Reporting and Resolution
+
+### Before You Report a Bug
+
+1. **Make sure it's a BuddyPress issue**: Deactivate all your plugins but BuddyPress, switch to one of the WordPress bundled themes (Twenty Twenty-{Year}). If you added files into the `/wp-content/mu-plugins` folder or added a `wp-content/plugins/bp-custom.php` file: remove them temporarily. Check you can still reproduce the bug.
+2. **Search for Existing Reports**: Ensure the bug still needs to be reported by searching Trac.
+ - If found, do not report a duplicate. Instead, add any additional information to the existing report.
+ - If the issue is similar but not identical, decide whether to add a note to the existing issue or report a new one.
+3. **Discussion**: If unsure whether it’s a bug, discuss it on the [BuddyPress Support Forums](https://buddypress.org/support/) or the [Buddypress Slack channel](https://wordpress.slack.com/messages/buddypress).
+
+### Reporting a Bug
+
+BuddyPress uses the same tool WordPress is using to manage its code source as well as bugs reporting. We call it "Trac" and it's available at this URL:
+[https://buddypress.trac.wordpress.org/](https://buddypress.trac.wordpress.org/)
+
+You can read this [WordPress contributor documentation page](https://make.wordpress.org/core/handbook/contribute/trac/keywords/#status-based-keywords) for more details about it.
+
+1. **Log into Trac**: Use your BuddyPress forum username and password to log into Trac and click on the "[New Ticket](https://buddypress.trac.wordpress.org/newticket)" tab.
+2. **Fill in the Ticket Fields**:
+ - **Short Summary**: Provide a concise and informative title.
+ - **Full Description**: Describe the problem, steps to reproduce it, and include any relevant URLs or screenshots. To provide detailed environment information, you can use the [Test Reports plugin](https://wordpress.org/plugins/test-reports/) or have a look at the debug information provided by the BuddyPress panels of the Tools / Site Health / Info screen of your WordPress Dashboard.
+ - **Priority**: Leave this to default; developers will rank the bug’s priority.
+ - **Assign to**: Optionally, take responsibility for the bug by entering your username.
+ - **Milestone**: Do not change this; a BuddyPress developer will set it.
+ - **Keywords**: Identify affected areas and use standard keywords to flag the bug’s status.
+ - **CC**: Enter your email to receive updates on the bug. Reporters are automatically notified.
+ - **Attachments**: You can use this section to upload screenshots or [submit a patch](README.md#suggesting-a-fix).
+
+### Trac Keywords
+
+The following list is not exhaustive, but it gives you a good idea of what means most commonly used keywords. You can also read about the [Keywords WordPress is using](https://make.wordpress.org/core/handbook/contribute/trac/keywords/#status-based-keywords) as we also use most of them.
+
+- **reporter-feedback**: A response is needed from **You**: the reporter.
+- **has-patch**: A solution has been attached and is ready for review.
+- **needs-testing**: The solution requires testing.
+- **2nd-opinion**: Another opinion is needed on the problem or solution.
+- **dev-feedback**: A developer’s response is requested (less commonly used).
+- **tested**: The patch has been tested; include the patch filename, testing method, and BuddyPress version.
+- **needs-patch**: The ticket needs a patch or the submitted patch needs revision.
+
+### Finding Bugs to Fix
+
+Refer to the [Available Reports](https://buddypress.trac.wordpress.org/report/) for links to Trac reports showing which bugs need fixing.
+
+## Joining the BuddyPress Slack Channel
+
+To discuss bugs and other issues, join the [BuddyPress Slack channel](https://wordpress.slack.com/messages/buddypress) by following these steps:
+
+1. Visit [chat.wordpress.org](https://chat.wordpress.org).
+2. Scroll to the section “Joining the WordPress team on Slack”.
+3. Click the link that says, “I understand. Let’s get started.”
+4. You will be taken to the Slack login webpage.
+5. Enter your WordPress.org username as your “email” with the pre-filled subdomain `chat.wordpress.org`.
+6. Check your email for a confirmation from Slack. (The email will be automatically forwarded to the email address for your WordPress.org account.)
+7. In the confirmation email, click the “Confirm email” link.
+8. You will be taken to a Slack webpage to set your password.
+9. Add your name and select a new password for your Slack account.
+10. You will be logged in to the Making WordPress Slack on your browser.
+
+By following these guidelines, you contribute to maintaining and improving BuddyPress, helping the community to grow and thrive.
</ins></span></pre></div>
<a id="trunkdocscontributormanifestjson"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/docs/contributor/manifest.json</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/contributor/manifest.json 2024-08-19 18:57:51 UTC (rev 14007)
+++ trunk/docs/contributor/manifest.json 2024-08-19 19:37:13 UTC (rev 14008)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,6 +54,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "parent": null
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "title": "Reporting Bugs",
+ "slug": "report-bugs",
+ "markdown_source": "../contributor/code/report-bugs.md",
+ "parent": null
+ },
+ {
</ins><span class="cx" style="display: block; padding: 0 10px"> "title": "Contribute to Support",
</span><span class="cx" style="display: block; padding: 0 10px"> "slug": "contribute-to-support",
</span><span class="cx" style="display: block; padding: 0 10px"> "markdown_source": "../contributor/support/README.md",
</span></span></pre>
</div>
</div>
</body>
</html>