Add information about including Zulip links in GitHub issues

FHIR · Jun 19, 2024 · a1a2e34 · a1a2e34
1 parent db172dd
commit a1a2e34
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/BEST-PRACTICES.md b/BEST-PRACTICES.md
@@ -5,6 +5,7 @@ We're glad you're considering contributing to SUSHI! Below are a few best practi
 ## Before contributing
 
 Before contributing a feature or a bugfix, we recommend creating a GitHub issue if one does not exist. This allows the community to provide feedback on why an issue may be occurring or provide additional insight into a suggested feature.
+When creating a GitHub issue, include a description of the feature or bug, any steps needed to demonstrate the issue, and any links to relevant discussion threads on [Zulip](https://chat.fhir.org).
 
 If a GitHub issue already exists for what you are planning to contribute, we recommend commenting on the issue to indicate that you are working on an implementation to avoid duplication of work.
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -27,6 +27,8 @@ When submitting a bug report, please try to provide as much detail as possible.
 - relevant outputs
 - any other information you deem relevant
 
+When creating or contributing to an issue, please include a link to any relevant discussion threads on [Zulip](https://chat.fhir.org) (see below).
+
 Please note that the GitHub issue tracker is _public_; any issues you submit are immediately visible to everyone. For this reason, do _not_ submit any information that may be considered sensitive.
 
 ## Zulip