Skip to content

Latest commit

 

History

History
126 lines (69 loc) · 6.52 KB

SUPPORT.md

File metadata and controls

126 lines (69 loc) · 6.52 KB
Raw

Support

How to get help with stdlib.

This document explains how to get help with stdlib. Please read through the following guidelines.

👉 Note: before participating in our community, please read our Code of Conduct. By interacting with this repository, organization, or community, you agree to abide by its terms.

Getting Help

Please seek support in the following ways:

  • Bugs: if you have found a bug or would like to make a specific feature request, please file an issue on the stdlib issue tracker.
  • Security vulnerabilities: if you would like to report a security vulnerability, please consult the stdlib security policy and follow requested steps for responsible disclosure.
  • Questions: for general questions (i.e., concerns which are not bug reports or explicit feature requests), please ask on either GitHub discussions or on Gitter.

Please do not file issues on the issue tracker seeking help or support debugging your application or open-source project when the encountered issues are specific to your project. You will have better luck in such instances seeking help from other users of stdlib via Stack Overflow or other non-stdlib affiliated public forums.

Asking Quality Questions

Help us help you! Be sure to spend time framing questions and to provide links and other resources. Spending extra time at the outset can help save everyone time in the long run.

When seeking help, you are encouraged to adhere to the following principles in order to increase the likelihood of receiving a successful response:

  • Read documentation and other guides for the project to see if you can answer the question or figure out the issue on your own. Try locating an example project, and explore how the project works to see if you can answer your question.

  • Search for existing questions and answers by consulting the stdlib issue tracker, discussions, and FAQ. For debugging issues specific to your project or figuring out how to use stdlib in a manner unique to your application, search for answers and ask questions on Stack Overflow.

  • Try "rubber ducking" to see if verbalizing and discussing the problem helps reveal or challenge any of your current assumptions.

  • Ensure that you ask about your actual problem and not your attempted solution (i.e., do not fall prey to the XY problem).

  • Define what you need help with by asking the following questions:

    • Are you confronted with a concept that you do not understand? If so, consider engaging more deeply with project documentation and seeking out example projects from which you can learn.
    • What are you specifically wanting to do? The more specific you are, the more targeted your response.
    • What problem are you encountering? The more granular you are in terms of circumstances, the more quickly others can reproduce the issue.
    • What steps have you taken to try and fix the problem? If you have settled on a particular solution, explain why the other attempts have failed.

  • Provide sample code, but do not attach your entire project for someone else to debug. Instead, provide a minimal reproducible example of the issue you are encountering.

  • Prefer providing code and error messages as text rather than screenshots. While screenshots can be useful, maintainers will benefit from being to engage directly with important text, especially when attempting to reproduce the encountered issue.

  • Proofread and cross-check your question to ensure that your question is communicated as clearly as possible.

  • Do not open duplicate issues or litter an existing issue with separate "+1" comments. If you want to "upvote" an issue or comment, instead of posting a separate comment, use GitHub's built-in reaction support to record a 👍 emoji response.

  • Do not e-mail (or reach out to via social media) specific project authors or contributors asking for help debugging your project or application. Please be respectful of maintainer time, and respect that maintainers are likely to have other obligations outside of stdlib.

Contributing

If you are interested in contributing to stdlib, please see the stdlib contributing guide for guidance on how to contribute.

Attribution

This policy document draws from the following support documents:

License

This document may be reused under a Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Copyright

Copyright © The Stdlib Authors.