Provide more guidance on asking questions #6226
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tjhei
approved these changes
Feb 7, 2025
CONTRIBUTING.md
Outdated
| duplicate of your question. | ||
| - If you did not find an answer in the previous searches, open a new question: | ||
| - If you suspect you have found a bug, open a new [issue](https://github.com/geodynamics/aspect/issues/new) | ||
| and explain your problem as described below. |
There was a problem hiding this comment.
did you do this line break without indentation on purpose? It looks a little off.
There was a problem hiding this comment.
That was an accident. Fixed now. I also modified some line breaks to make sure long links are on one line.
CONTRIBUTING.md
Outdated
| and explain your problem as described below. | ||
| - If you are not sure how to set up a model, ask a question in | ||
| the [ASPECT forum](https://community.geodynamics.org/c/aspect) as described below. | ||
| - If you are not sure what to do, also open a question in the |
There was a problem hiding this comment.
Suggested change
| - If you are not sure what to do, also open a question in the | |
| - If you are not sure what to do, you can post a question in the |
CONTRIBUTING.md
Outdated
| - any information that helps us understand why you think this is a bug (screenshots, data series, comparisons to reference results, etc.) | ||
| - instructions how to reproduce the problem. | ||
|
|
||
| Without providing the information above, we will less likely be able to help you, it may take significantly longer until |
There was a problem hiding this comment.
Suggested change
| Without providing the information above, we will less likely be able to help you, it may take significantly longer until | |
| Without providing the information above, we will be less likely be able to help you, it may take significantly longer until |
Sounds reasonable to me. |
gassmoeller
force-pushed
the
improve_bug_instructions
branch
from
cc18fb9 to
24a6762
Compare
naliboff
approved these changes
Feb 10, 2025
CONTRIBUTING.md
Outdated
|
|
||
| - Make sure you have run your model in | ||
| [DEBUG mode](https://aspect-documentation.readthedocs.io/en/latest/user/run-aspect/debug-mode.html). | ||
| DEBUG mode reports many errors in greater details and may already solve your |
There was a problem hiding this comment.
Suggested change
| DEBUG mode reports many errors in greater details and may already solve your | |
| DEBUG mode reports many errors in greater detail and may already solve your |
CONTRIBUTING.md
Outdated
| screen, | ||
| - any information that helps us understand why you think this is a bug | ||
| (screenshots, data series, comparisons to reference results, etc.) | ||
| - instructions how to reproduce the problem. |
There was a problem hiding this comment.
Suggested change
| - instructions how to reproduce the problem. | |
| - instructions for how to reproduce the problem. |
CONTRIBUTING.md
Outdated
| - one or several screenshots of the full error message you saw on your | ||
| screen, | ||
| - any information that helps us understand why you think this is a bug | ||
| (screenshots, data series, comparisons to reference results, etc.) |
There was a problem hiding this comment.
Suggested change
| (screenshots, data series, comparisons to reference results, etc.) | |
| (screenshots, data series, comparisons to reference results, etc.), |
gassmoeller
force-pushed
the
improve_bug_instructions
branch
from
24a6762 to
84da171
Compare
|
Thanks for the reviews! Should be all fixed now. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have updated our CONTRIBUTING.md to provide more guidance on how to ask questions in the forum. I also moved the section about git and github to a more appropriate place (closer to contributing code) and moved the entry about contributing higher up in the corresponding manual section (currently the contributing guidelines are almost at the end of the contributing section).
Could you check if I hit the right tone and the changes make sense? Once this is merged I also want to link to it from a pinned post in the forum. That makes it easier for us to point everyone to this document when we need more information for issues or forum posts.