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

Link to CONTRIBUTING in SSM UI #191

Closed
danshearer opened this issue Jul 15, 2024 · 1 comment · Fixed by #202
Closed

Link to CONTRIBUTING in SSM UI #191

danshearer opened this issue Jul 15, 2024 · 1 comment · Fixed by #202
Assignees

Comments

@danshearer
Copy link
Member

danshearer commented Jul 15, 2024

As discussed with @kenmeacham , it would be good to link to CONTRIBUTING.md in the UI. The link could be at least in "Help/About", however, the more places the better.

For context, note that #189 will make this even better.

Implementing these means we get to modify how we engage with would-be contributors without changing the UI. And we don't want to be like this experience:

As is commonly the case in software development, the difficult part of this fix had nothing to do with the code itself. All of my effort was spent figuring out Ubuntu’s patch submission processes and advocating for my merge request.

which the author reports on in great (but good) detail .

This sort of reason is why our contributor document is big on being friendly and small on making rules.

@kenmeacham
Copy link
Contributor

How about an option in the Help menu to be able to report an issue, e.g.

image

Rather than the top-level Contributing page, maybe it could link directly to the section explaining how to create an issue:
https://github.com/Spyderisk/system-modeller/blob/dev/CONTRIBUTING.md#how-to-open-a-query-or-bug-report

CC @scp93ch

@kenmeacham kenmeacham linked a pull request Aug 23, 2024 that will close this issue
kenmeacham added a commit that referenced this issue Sep 17, 2024
…m-ui

#191: Add "Report an Issue" option in Help menu
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

Successfully merging a pull request may close this issue.

2 participants