mirror of
				https://github.com/zulip/zulip.git
				synced 2025-11-04 05:53:43 +00:00 
			
		
		
		
	docs: Correct minor wording and mechanics.
This commit is contained in:
		
				
					committed by
					
						
						Karl Stolley
					
				
			
			
				
	
			
			
			
						parent
						
							e1c809a71e
						
					
				
				
					commit
					2720e0e35a
				
			@@ -1,6 +1,6 @@
 | 
				
			|||||||
# Reporting bugs
 | 
					# Reporting bugs
 | 
				
			||||||
 | 
					
 | 
				
			||||||
The are several ways to report bugs (or possible bugs) you encounter in Zulip.
 | 
					There are several ways to report bugs (or possible bugs) you encounter in Zulip:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- If you have a concrete bug report with steps to reproduce the behavior, [file an
 | 
					- If you have a concrete bug report with steps to reproduce the behavior, [file an
 | 
				
			||||||
  issue](#filing-a-github-issue) in the appropriate GitHub repository.
 | 
					  issue](#filing-a-github-issue) in the appropriate GitHub repository.
 | 
				
			||||||
@@ -25,7 +25,7 @@ what to include in a bug report.
 | 
				
			|||||||
   Include screenshots and/or screen captures (see [recommended
 | 
					   Include screenshots and/or screen captures (see [recommended
 | 
				
			||||||
   tools](../tutorials/screenshot-and-gif-software.md)) if they help
 | 
					   tools](../tutorials/screenshot-and-gif-software.md)) if they help
 | 
				
			||||||
   communicate what you are describing, but avoid posting long videos.
 | 
					   communicate what you are describing, but avoid posting long videos.
 | 
				
			||||||
1. Indicate the **[version](https://zulip.com/help/view-zulip-version)** of the
 | 
					1. **Indicate the [version](https://zulip.com/help/view-zulip-version)** of the
 | 
				
			||||||
   Zulip app where you encountered the bug. It may also be helpful to note your
 | 
					   Zulip app where you encountered the bug. It may also be helpful to note your
 | 
				
			||||||
   operating system, whether you are using the web app or the desktop app, and
 | 
					   operating system, whether you are using the web app or the desktop app, and
 | 
				
			||||||
   your browser if using the web app.
 | 
					   your browser if using the web app.
 | 
				
			||||||
@@ -44,10 +44,10 @@ Filing a GitHub issue works best when:
 | 
				
			|||||||
If all of the above accurately describe your situation, please file an issue!
 | 
					If all of the above accurately describe your situation, please file an issue!
 | 
				
			||||||
Otherwise, we recommend [starting a
 | 
					Otherwise, we recommend [starting a
 | 
				
			||||||
conversation](#starting-a-conversation-about-a-possible-bug) in the Zulip
 | 
					conversation](#starting-a-conversation-about-a-possible-bug) in the Zulip
 | 
				
			||||||
development community, so that the problem you encountered can be discussed
 | 
					development community so that the problem you encountered can be discussed
 | 
				
			||||||
interactively.
 | 
					interactively.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Steps and best practices for filing an issue:
 | 
					Steps and best practices for filing a GitHub issue:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
1. Report the issue in the **appropriate [Zulip
 | 
					1. Report the issue in the **appropriate [Zulip
 | 
				
			||||||
   repository](https://github.com/zulip)**. The most commonly used repositories
 | 
					   repository](https://github.com/zulip)**. The most commonly used repositories
 | 
				
			||||||
@@ -58,8 +58,8 @@ Steps and best practices for filing an issue:
 | 
				
			|||||||
   - [zulip/zulip-mobile](https://github.com/zulip/zulip-mobile/issues) for
 | 
					   - [zulip/zulip-mobile](https://github.com/zulip/zulip-mobile/issues) for
 | 
				
			||||||
     issues with the mobile apps.
 | 
					     issues with the mobile apps.
 | 
				
			||||||
   - [zulip/zulip-desktop](https://github.com/zulip/zulip-desktop/issues) for
 | 
					   - [zulip/zulip-desktop](https://github.com/zulip/zulip-desktop/issues) for
 | 
				
			||||||
     issues that are specific to the Zulip desktop app, and _do not_ occur in
 | 
					     issues that are specific to the Zulip desktop app, and therefore _do not_
 | 
				
			||||||
     the web app.
 | 
					     occur in the web app.
 | 
				
			||||||
   - [zulip/zulip-terminal](https://github.com/zulip/zulip-terminal/issues) for
 | 
					   - [zulip/zulip-terminal](https://github.com/zulip/zulip-terminal/issues) for
 | 
				
			||||||
     issues with the terminal app.
 | 
					     issues with the terminal app.
 | 
				
			||||||
2. Do a **quick search** of the repository to see if your issue has already
 | 
					2. Do a **quick search** of the repository to see if your issue has already
 | 
				
			||||||
@@ -96,8 +96,8 @@ Steps and best practices for starting a conversation:
 | 
				
			|||||||
   - [#mobile](https://chat.zulip.org/#narrow/stream/48-mobile) for issues with
 | 
					   - [#mobile](https://chat.zulip.org/#narrow/stream/48-mobile) for issues with
 | 
				
			||||||
     the mobile apps.
 | 
					     the mobile apps.
 | 
				
			||||||
   - [#desktop](https://chat.zulip.org/#narrow/stream/16-desktop) for issues
 | 
					   - [#desktop](https://chat.zulip.org/#narrow/stream/16-desktop) for issues
 | 
				
			||||||
     that are specific to the Zulip desktop app, and _do not_ occur in the web
 | 
					     that are specific to the Zulip desktop app, and therefore _do not_
 | 
				
			||||||
     app.
 | 
					     occur in the web app.
 | 
				
			||||||
   - [#zulip-terminal](https://chat.zulip.org/#narrow/stream/206-zulip-terminal)
 | 
					   - [#zulip-terminal](https://chat.zulip.org/#narrow/stream/206-zulip-terminal)
 | 
				
			||||||
     for issues with the terminal app.
 | 
					     for issues with the terminal app.
 | 
				
			||||||
   - [#production
 | 
					   - [#production
 | 
				
			||||||
@@ -112,7 +112,7 @@ Moderators can always rename the topic, or move the thread to another stream.
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
Once a possible bug is reported, members of the development community will jump
 | 
					Once a possible bug is reported, members of the development community will jump
 | 
				
			||||||
in to discuss whether the report constitutes a bug, how to reproduce it, and how
 | 
					in to discuss whether the report constitutes a bug, how to reproduce it, and how
 | 
				
			||||||
it can be resolved. The initial reporter can help by monitoring the discussion,
 | 
					it can be resolved. The initial reporter can help by monitoring the discussion
 | 
				
			||||||
and replying to any follow-up questions. If the report is determined to be a
 | 
					and replying to any follow-up questions. If the report is determined to be a
 | 
				
			||||||
reproducible bug, a GitHub issue will be filed to keep track of it (see below).
 | 
					reproducible bug, a GitHub issue will be filed to keep track of it (see below).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -130,7 +130,7 @@ in the discussion thread, as message links will still work even if the topic is
 | 
				
			|||||||
renamed or resolved.
 | 
					renamed or resolved.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
- If you encounter a definite bug with a clear reproducer and significant user
 | 
					- If you encounter a definite bug with a clear reproducer and significant user
 | 
				
			||||||
  impact, it is best to both file a GitHub issue, and immediately start a
 | 
					  impact, it is best to both file a GitHub issue and immediately start a
 | 
				
			||||||
  discussion in the development community. This helps us address important
 | 
					  discussion in the development community. This helps us address important
 | 
				
			||||||
  issues as quickly as possible.
 | 
					  issues as quickly as possible.
 | 
				
			||||||
- For minor bugs (e.g., a visual glitch in a settings menu for very long stream
 | 
					- For minor bugs (e.g., a visual glitch in a settings menu for very long stream
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -33,7 +33,7 @@ Steps and best practices for starting a conversation:
 | 
				
			|||||||
1. [**Join** the Zulip development
 | 
					1. [**Join** the Zulip development
 | 
				
			||||||
   community](https://zulip.com/development-community/) if you don't already
 | 
					   community](https://zulip.com/development-community/) if you don't already
 | 
				
			||||||
   have an account.
 | 
					   have an account.
 | 
				
			||||||
2. Pick an **appropriate stream** to report your issue:
 | 
					2. Pick an **appropriate stream** to discuss your idea:
 | 
				
			||||||
   - [#feedback](https://chat.zulip.org/#narrow/stream/137-feedback) for suggestions for
 | 
					   - [#feedback](https://chat.zulip.org/#narrow/stream/137-feedback) for suggestions for
 | 
				
			||||||
     the Zulip web app or server. A good default if you aren't sure which stream
 | 
					     the Zulip web app or server. A good default if you aren't sure which stream
 | 
				
			||||||
     to use.
 | 
					     to use.
 | 
				
			||||||
@@ -47,7 +47,7 @@ Steps and best practices for starting a conversation:
 | 
				
			|||||||
     help](https://chat.zulip.org/#narrow/stream/31-production-help) for suggestions
 | 
					     help](https://chat.zulip.org/#narrow/stream/31-production-help) for suggestions
 | 
				
			||||||
     related to self-hosting Zulip.
 | 
					     related to self-hosting Zulip.
 | 
				
			||||||
3. **[Start a new topic](https://zulip.com/help/starting-a-new-topic)** for
 | 
					3. **[Start a new topic](https://zulip.com/help/starting-a-new-topic)** for
 | 
				
			||||||
   discussing your suggestions, using a brief summary of the proposal as the
 | 
					   discussing your suggestions, using a brief summary of your idea as the
 | 
				
			||||||
   name of the topic.
 | 
					   name of the topic.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
If you aren't sure where to post or how to name your topic, don't worry!
 | 
					If you aren't sure where to post or how to name your topic, don't worry!
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user