Update docs to use [email protected] #6804
Conversation
The Code of Conduct still referred people to Bálint, so that needed to be changed. Also, it seems like a good idea to mention the maintainers' address in the top-level README file.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6804 +/- ##
=======================================
Coverage 97.85% 97.85%
=======================================
Files 1084 1084
Lines 93674 93680 +6
=======================================
+ Hits 91665 91671 +6
Misses 2009 2009 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
CODE_OF_CONDUCT.md
Outdated
| consisting of representatives from the Open Source Programs Office and the | ||
| Google Open Source Strategy team. If for any reason you are uncomfortable | ||
| reaching out to the Project Steward, please email [email protected]. | ||
| Reports should be directed to [[email protected]](mailto:[email protected]), |
There was a problem hiding this comment.
Nit - GitHub seems to detect and activate email links in markdown and rst without special syntax. Please adjust here and below. Temporary example: https://github.com/quantumlib/Cirq/blob/40832d819322777e851e8a1d7cd22ccd2d3832c8/CODE_OF_CONDUCT.md#conflict-resolution
Also, let us keep the 80-character line wrap for the sake of those who read text files as text. :-)
| Reports should be directed to [[email protected]](mailto:[email protected]), | |
| Reports should be directed to [email protected], |
There was a problem hiding this comment.
I guess I never noticed that before. Thanks for the tip!
Regarding 80 chars: in fact, I try to do that always, but in this case, the README.rst file already had those long lines, and I didn't want to format it in order to keep this PR only about the address changes. I'm working on converting the files to Markdown and am about to do a PR for that, and there, the results will be ≤ 80 chars.
There was a problem hiding this comment.
@pavoljuhas I could, however, reformat the README.rst file to keep to 80 chars, if that's preferred?
There was a problem hiding this comment.
@mhucka - apologies about the confusion - I meant the CODE_OF_CONDUCT.md which is within the 80 char limit in the main, so it would be nice to keep such format after the PR.
No need to worry about README.rst if it already has long lines. I agree this can be left for later, especially if you already plan on converting to markdown. (we also don't want to have a lot of extra diffs beyond the subject of the PR)
There was a problem hiding this comment.
OK, at first I thought I couldn't break the mailto hyperlinks across lines in the CoC file, but I just checked, and yes it is. So you're right, I should have done that.
That's no longer needed with the change to avoid hyperlinking, but I'll know to do that in the future.
Turns out GH automatically links email addresses.
Co-authored-by: Pavol Juhas <[email protected]>
The Code of Conduct still referred people to Bálint, so that needed to be changed. Also, it seems like a good idea to mention the maintainers' address in the top-level README file.