Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft Guideline to ask a question #15

Open
2 tasks
MGomezN opened this issue Jul 30, 2023 · 1 comment
Open
2 tasks

Draft Guideline to ask a question #15

MGomezN opened this issue Jul 30, 2023 · 1 comment

Comments

@MGomezN
Copy link

MGomezN commented Jul 30, 2023

As one of the action items at the BIRS Workshop: Open-Source Tools to Enable Geophysical Data Processing and Inversion, we worked on putting together a draft containing some important steps to orientate people about asking questions son Slack/ GitHub Forum.
Task

  • Insert these guidelines as default, every time a person asks a question (Q&A)
  • Create a welcome message (bot) to remind people about these steps.

---- Text-------

This is a supportive environment for asking questions, where no question is considered "stupid."
However, before asking questions, be sure to do your research. -put significant effort into finding your own solutions. Use the available resources, e.g. (previous questions on the forum, documentation, and Youtube tutorials).
Also, remember that Fatiando/Simpeg community members are professionals (professors, postdocs, students, and industry professionals) who are volunteering their time to resolve your issues. Please be patient and kind.

To ensure prompt resolution of your queries, we encourage you to adhere to the following five steps:

  • Craft a concise and descriptive title

Good title: How does the order of arithmetical operations go on Python?
Bad title: [numpy] Numbers doubt

  • Introduce Yourself. This is an opportunity to build your network
  • Provide problem context before sharing code. Offer relevant background information and describe your issue in words. Explain how you encountered the problem and any challenges you've faced while attempting to solve it.
  • Help others reproduce the problem
  • Include the necessary code snippets that allow others to replicate the issue you're experiencing.
  • Utilize screenshots for code, data, or error messages

Content adapted from
https://stackoverflow.com/help/how-to-ask
https://twitter.com/GeostatsGuy/status/1256975510703390726

@jcapriot
Copy link
Member

This is great stuff!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants