Skip to content

Add guidance on how to solve problems to the issue template #337 #338

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.

Sign up for GitHub

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

Open
Satyamgupta2365 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add guidance on how to solve problems to the issue template #337 #338

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion utils/mdakit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,12 @@ def _create_issue(run_type: str):
f" - installing mdanalysis: {_bool_status(stat.install_mdanalysis)}\n"
f" - installing the test dependencies: {_bool_status(stat.install_test_deps)}\n"
f" - running tests: {_bool_status(stat.run_tests)}\n"
f"Pinging maintainers: {maint}"
f"Pinging maintainers: {maint}\n\n"
f"---\n"
f"**How to resolve this:**\n\n"
f"- **Check the `metadata.yaml`**: Ensure your kit's `metadata.yaml` is up-to-date.\n"
f"- **Check why the pipeline is failing**: Look at the CI logs to find the exact point of failure. See the [documentation on finding the CI error](https://mdakits.mdanalysis.org/maintaining_a_kit/keep-healthy.html#why-did-ci-fail).\n"
f"- **Pipeline details**: For an in-depth explanation of how the MDAKits Registry CI works, please see [the documentation here](https://mdakits.mdanalysis.org/maintaining_a_kit/keep-healthy.html#mdakitsci).\n"
)

repo.create_issue(title=issue_title, body=issue_body)
Expand Down