-
-
Notifications
You must be signed in to change notification settings - Fork 430
Improve user friendliness of CONTRIBUTING.md #2811
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
Conversation
Add some more general preamble to CONTRIBUTING.md: * to be a more friendly introduction to contributing for newcomers; and * to cover ways to contribute other than Picard code.
|
@Sophist-UK Thanks for your contribution. Could you rebase your branch against master? I had just some Markdown linting changes merged with #2813 . Also Codacy is now removed. Github actions is currently acting up, though, expect tests to fail. But we can rerun them once Github is stable again. |
|
@phw Phillip - I think I have rebased it. Let me know if there is still an issue. And given that this is solely a markdown file change, I didn't bother checking that the tests still worked. |
phw
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks again. Looks good to me, good to have a broader introduction here. I have only some minor content related comments.
Also our Markdown linting is complaining. But it is only two issues:
- Use dashes for lists instead of asterisk for consistency
- Get rid of trailing whitespace in several lines
|
@phw @zas This PR only changes a single *.MD file which is NOT a code change and is not included in a package, yet it runs CodeQL, package release checks, various non-MD code linting, and all the unit tests, none of which have any relevance to this PR. So as an aside, may I suggest that we reduce our automation carbon footprint by adding filters to each Github workflow so that it only runs when either the workflow yaml file itself has changed or the relevant types of file have changed. |
|
@Sophist-UK Yes, we should limit the unit tests. I'll look into this. We already have the packaging restricted. The linting is probably more trouble to check whether something has changed then to just run it, since we move all those checks into a single workflow file, which makes maintenance much easier for those small checks. The PR here looks good. I'd like to have this reviewed by @zas before merging, though. He did the last big update to this file. |
zas
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Summary
Add some more general preamble to CONTRIBUTING.md: