Hello, I am a scap newbie, trying to learn how things work and I, as a person from the outside, have noticed some patterns that make contributions less fun. I would also like to propose remediations (that could make it into the contribution guide if you agree):
Here is what was not ideal:
A GitHub issue was created, development of the fix was underway, but nobody had the issue assigned.
Proposed resolution:
- When one is implementing functionality that is requested in a GitHub issue and he/she is aware that the issue exists, one should mention the issue in the PR and one should also request to have the issue assigned to him/her. ---
Git magic was involved in the pull request, so there were outdated comments from the reviewer, but at the same time, there was a single (and therefore huge and difficult to analyze) commit.
Proposed resolution:
- When doing pull requests, don't alter past commits when the pull request is underway. This makes it easier for others to follow and understand the evolution of the pull request. (One can use GitHub squash merge at the end, right?). ---
I am referring to issue #2322 and PR #2381; although those two things that I have pointed out are not heavy stuff, they make contributions to SSG less accessible, because they obscure what's going on to a certain degree. On the other hand, I appreciate that the PR that I have created got its attention and I could learn from the feedback quite quickly.
Best regards, Matej Tyc
scap-security-guide@lists.fedorahosted.org
-
Matěj Týč