fatiando / community

Community resources, guidelines, meeting notes, authorship policy, maintenance, etc.
Other
8 stars 5 forks source link

Draft Guideline to ask a question #119

Open MGomezN opened 1 year ago

MGomezN commented 1 year ago

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

---- 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