JOSS Review

[a-vanderheiden]

Contains all commits generated from the JOSS review process.

[Atreyagaurav]

For future reference: https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue

Putting something like "fixes #45" in your commit message (you can write multi line messages, the description lines won't show by default), means the issue will be closed automatically when the pull request is merged in the default branch. And it will also show in the issue, so people can refer to that.

Manually closing issues before they are merged in the default branch is confusing for people that run into the same issue. Waiting to close it after merge is just an extra step when you can automatically link it.

You can also manually link them (refer the page linked above), but just adding the keywords in the commit or merge request description is easier.

[a-vanderheiden]

@Atreyagaurav Thank you for the pointer! As you've probably noticed, I'm still learning norms/best practices for collaboration on GitHub, so this is really helpful :)

I'll try out this feature in the commit message next time

[Atreyagaurav]

No worries. I just wanted to mention it because I saw you closing a lot of issues, and I was thinking "it's not merged yet". It's just a nice little feature.

Relevant: https://xkcd.com/1053/

[a-vanderheiden]

Yeah, I was closing them so I could better keep track of the issues that I still needed to address. I totally see the logic now though in keeping them open till they're merged with main.

Relevant: https://xkcd.com/1053/

100% 😆 I'll have to add that one to my xkcd reference list