diggsweden / jitsi-outlook

A Jitsi plugin for outlook.

MIT License

5 stars 7 forks source link

30: Added Public Code badge #32

Closed Ayko1595 closed 10 months ago

Ayko1595 commented 11 months ago

Pull Request Template

Description

This PR includes the Public Code commitment badge and a link to their repository. By adding this badge we make it clear that we are in the process of being compliant to their guidelines and rules

Fixes #30

Checklist

[x] My contributions and commit messages follows the style guidelines of this project
[x] I have made corresponding changes to the documentation
[x] New and existing unit tests pass locally with my changes
[x] The Pull Request has an informative and human-readable title
[x] Changes are limited to a single goal (avoid scope creep)
[x] Code can be automatically merged (no conflicts)
[x] I confirm that I have read any Contribution guidelines (CONTRIBUTING)
[x] I confirm that I wrote and/or have the right to submit the contents of my PR, by agreeing to the Developer Certificate of Origin, by adding a 'sign-off' to my commits

janderssonse commented 10 months ago

Looks good to me. As I understood, the badge is ok for aspiring projects "If you wish to advertise the codebase community's aspiration to meet the criteria of the Standard for Public Code, link the documentation of this commitment from the standard-for-public-code-commitment badge." So why not!:)

Ainali commented 10 months ago

As I understood, the badge is ok for aspiring projects "If you wish to advertise the codebase community's aspiration to meet the criteria of the Standard for Public Code, link the documentation of this commitment from the standard-for-public-code-commitment badge."

A small comment that I also put in Rocketchat, the "link the documentation of this commitment" is not meant to link to the Standard for Public Code, but to have the badge link to the README or CONTRIBUTING (or similar) where you make it clear for contributors that new contributions should aim to bring the codebase closer to meeting the criteria rather than drifting further apart. (By doing that is more explicit to the contributors what is expected from them and you can link to the Standard from there rather from the badge itself.)

Ayko1595 commented 10 months ago

@Ainali Oh I see, so we should add a short section in the plugin's documentation where we mention that we are aiming to follow the Public Code guidelines? And then link to that section?

Ainali commented 10 months ago

@Ayko1595 Yes, that is the intention. Perhaps in the future, when the Standard for Public Code and the badge are widely known, it won't be needed. But for now, I think that would be very helpful for anyone who wants to contribute to this repository.

Ayko1595 commented 10 months ago

@Ainali Ahh alright, I'll change it then! Sorry for the confusion 😊

janderssonse commented 10 months ago

Nice, I'll make sure to add the same thing to the template project too

Ayko1595 commented 10 months ago

I decided to go with a === heading because it falls into the section about contributing code. For now I think that will suffice, but if the section grows we could definitely move it out to its own section! 😊