🔄 Synced file(s) with nebari-dev/.github (#1555)

* 🔄 Synced local '.github/ISSUE_TEMPLATE/' with remote '.github/ISSUE_TEMPLATE/' MAINT - Sync .github files 🤖 * 🔄 Synced local 'CONTRIBUTING.md' with remote 'CONTRIBUTING.md' MAINT - Sync .github files 🤖 Co-authored-by: nebari-sensei <null>
nebari-dev · Nov 18, 2022 · 08ebc4a · 08ebc4a
1 parent cab1c3b
commit 08ebc4a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -6,6 +6,9 @@ contact_links:
   - name: Nebari Discussions - our user forum
     url: https://github.com/orgs/nebari-dev/discussions
     about: Ask questions, discuss RFDs and help other Nebari's users
+  - name: Documentation issues 📖
+    about: Did you find an error in our documentation? Report your findings here.
+    url: https://github.com/nebari-dev/nebari-docs/issues/new/choose
   - name: (maintainers only) - Blank issue
     url: https://github.com/nebari-dev/nebari/issues/new
     about: For maintainers only - should be used sparingly
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -3,8 +3,8 @@
 Welcome 👋🏼!
 
 Thanks for being interested in contributing to Nebari. We’re glad you want to join this community!
-Open source doesn’t always have the best reputation for being friendly and welcoming, but the Nebari team truly believes that everyone belongs in open source,
-and we are dedicated to making you feel welcome.
+Open source doesn’t always have the best reputation for being friendly and welcoming, but the Nebari team truly believes
+that everyone belongs in open source, and we are dedicated to making you feel welcome.
 
 All contributions are welcome, including issues, contributing code, new docs as well as updates and tweaks, blog posts,
 helping out people, organizing community events, working on accessibility and design items, and more.
@@ -18,15 +18,16 @@ and apply all learnings to your own projects.
 
 ## Reporting issues
 
-When reporting issues please include as much detail as possible about your operating system, Nebari version and dependencies version.
+When reporting issues please include as much detail as possible about your operating system, Nebari version, and dependencies version.
 Whenever possible, also include a brief, self-contained code example that demonstrates the problem.
 This [blog post by Matthew Rockling](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) is a good primer on how to craft minimal bug reports.
 
 - Use the [Nebari issue tracker][nebari-issues] for issues, bug reports, and feature requests for Nebari.
 - Use the [Nebari documentation issue tracker][nebari-docs-issues] for documentation-related improvements.
+- Read more about [best practices for issues creation](https://www.nebari.dev/docs/community/file-issues) in our community docs.
 
 <!-- Links -->
 
 [nebari-docs-issues]: https://github.com/nebari-dev/nebari-docs/issues
 [nebari-issues]: https://github.com/nebari-dev/nebari/issues
-[nebari-community]: https://nebari.dev/community
+[nebari-community]: https://nebari.dev/docs/community