Skip to content
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

Update Code of Conduct #332

Merged
merged 10 commits into from
Mar 23, 2022
Merged

Update Code of Conduct #332

merged 10 commits into from
Mar 23, 2022

Conversation

RichardLitt
Copy link
Member

@RichardLitt RichardLitt commented Mar 22, 2022

I'd like approval from a lazy majority consensus of the organizing committee before merge.

Note that I've added a CoC FAQ and filled out as many of the questions I and @jwflory foresaw as I could.

@RichardLitt
Copy link
Member Author

@jdorfman @XhmikosR I don't care about these errors. Can you remove them from the tests?

code-of-conduct-faq.md:7 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# Code of Conduct FAQ"]
code-of-conduct-faq.md:16 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h3; Actual: h4]
code-of-conduct-faq.md:62:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
code-of-conduct-faq.md:63:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
code-of-conduct-faq.md:64:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
code-of-conduct.md:9 MD025/single-title/single-h1 Multiple top-level headings in the same document [Context: "# Code of Conduct"]
code-of-conduct.md:22:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
code-of-conduct.md:23:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
code-of-conduct.md:24:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
code-of-conduct.md:91:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
code-of-conduct.md:92:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]
code-of-conduct.md:93:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash]

Copy link
Contributor

@Erioldoesdesign Erioldoesdesign left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@RichardLitt
Copy link
Member Author

In case the diff is hard: here is where the text comes from. https://docs.google.com/document/d/1BxfHoV_zLSwZJbw1o-fF7MADfu0nLFi7-G8q3mc1Wqc/edit

@XhmikosR
Copy link
Collaborator

@RichardLitt https://github.com/sustainers/website/blob/main/.markdownlint.json

That being said, I wouldn't disable MD001 but rather fix it.

@RichardLitt
Copy link
Member Author

@XhmikosR I don't think it's a good rule. Is there a way to get a hint about it, instead of a failing error?

code-of-conduct-faq.md Outdated Show resolved Hide resolved
code-of-conduct-faq.md Outdated Show resolved Hide resolved
@XhmikosR
Copy link
Collaborator

XhmikosR commented Mar 22, 2022

@XhmikosR I don't think it's a good rule. Is there a way to get a hint about it, instead of a failing error?

It definitely is a good rule. Heading levels should follow a hierarchical order:

@RichardLitt
Copy link
Member Author

It definitely is a good rule.

As I said, I disagree. I don't think it's a useful rule, because I don't use headers according to the specification, but how they are displayed on the page. I don't respect the authority of w3 or Deque University over my own aesthetic preferences.

@XhmikosR
Copy link
Collaborator

It definitely is a good rule.

As I said, I disagree. I don't think it's a useful rule, because I don't use headers according to the specification, but how they are displayed on the page. I don't respect the authority of w3 or Deque University over my own aesthetic preferences.

Right. Shouldn't be to hard to figure out how to ignore it then.

@RichardLitt
Copy link
Member Author

Thanks. I can change the linter - my relevant question I'm not sure about is how can I make the tests not cause a failure in the build, but a warning? Alternatively, how can I change the test to fail on some of the issues, but only show a warning on others? I can look it up, but I think that you @XhmikosR and @jdorfman set this up, so I'm curious if you have thoughts on this first and know how faster.

slug: code-of-conduct-faq
---

# Code of Conduct FAQ
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This error can be ignored. It doesn't take in account for the Jekyll meta data
Image 2022-03-22 at 8 09 10 AM

Copy link
Member

@BenJam BenJam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've just read the content, not for grammatical or spelling but for the general gist of the content and how well it aligns to my understanding of the process and the conversations that we have had. On that basis LGTM

@XhmikosR
Copy link
Collaborator

It should be also possible to do something like this (untested):

### h3 heading that looks like h4
{: .h4 }

https://kramdown.gettalong.org/syntax.html#block-ials

Signed-off-by: Justin Dorfman <[email protected]>
@jdorfman
Copy link
Member

@XhmikosR these failed tests are not making sense. I fixed all of the errors and it still isn't passing. I'm probably doing something wrong, however I believe the test is flawed.

@XhmikosR
Copy link
Collaborator

@jdorfman fixed those

@RichardLitt
Copy link
Member Author

Thanks, @XhmikosR.

@jdorfman
Copy link
Member

Thanks @XhmikosR I swear I pushed the - to * change... 🤔

Image 2022-03-22 at 3 09 08 PM

@RichardLitt
Copy link
Member Author

I've had off-band messages from Pia and Gunner that this works for them. I'll merge this and institute it, and then schedule the next CoC conversation for three months from now.

Thank you everyone for all of your hard work!

@RichardLitt RichardLitt merged commit dc6b8aa into main Mar 23, 2022
@RichardLitt RichardLitt deleted the feat/coc branch March 23, 2022 12:07
@jdorfman
Copy link
Member

Great work y'all

@piamancini
Copy link
Member

LGTM - thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants