Skip to content
This repository was archived by the owner on Nov 6, 2023. It is now read-only.

Update CONTRIBUTING.md - #19638

Closed
zoracon wants to merge 2 commits into
masterfrom
zoracon-patch-docs-1
Closed

zoracon wants to merge 2 commits into
masterfrom
zoracon-patch-docs-1

Conversation

@zoracon

@zoracon zoracon commented Oct 1, 2020

Copy link
Copy Markdown
Contributor

Update Nonfunctional Hosts Standard

We have this in generated rules with make-trivial-rule script. It should be reflected in the Docs

Related: #14936

Update Nonfunctional Hosts Standard

We have this in generated rules with make-trivial-rule script. It should be reflected in the Docs
@zoracon zoracon added the docs label Oct 1, 2020
@pipboy96

pipboy96 commented Oct 2, 2020

Copy link
Copy Markdown
Contributor

@zoracon Let's change make-trivial-rule to match the docs instead, since we usually use that format.

@pipboy96

pipboy96 commented Oct 2, 2020

Copy link
Copy Markdown
Contributor

Also, is there evidence that this script is still used by people? Maybe we can completely remove it?

@zoracon

zoracon commented Oct 2, 2020

Copy link
Copy Markdown
Contributor Author

Also, is there evidence that this script is still used by people? Maybe we can completely remove it?

@pipboy96 I am not sure who uses this and who doesn't. I am going to research the background on why this comment for hosts was structured this way. There's a lot of discussion from a few years ago concerning this topic. I want to decide on a simplistic format going forward.

So my question is the format in make-trivial-rule more useful or is the more verbose format in the document better to keep?

@zoracon

zoracon commented Oct 2, 2020

Copy link
Copy Markdown
Contributor Author

To add, we also reference the make-trivial-rule tool in our Update Channels documentation
https://github.com/Hainish/https-everywhere/blob/master/docs/en_US/ruleset-update-channels.md

Which being actively experimented with at the moment.

@cschanaj

cschanaj commented Oct 8, 2020

Copy link
Copy Markdown
Collaborator

The style in make-trivial-rule was being discussed in #6868 and the agreement (tagged master list) was made by a number of contributors. However, I agree with @pipboy96 that the style in the documentation (grouped list) and its variants are more commonly seen. Personally, I prefer the style in the current documentation.

I believe the grouped list styles gained its popularity after the agreement is made. There was a time many contributors created their own bots for automatic generation of rulesets (#7691), and the grouped list styles turned out to be easier to parsers and formatters (e.g. #6912 (comment))

cc @jeremyn @J0WI @Hainish

@zoracon

zoracon commented Oct 8, 2020

Copy link
Copy Markdown
Contributor Author

Thank you for the background @cschanaj. I am inclined to go with the previous consensus instead of going down that path again. The conversation seemed to have come to a good middle ground between the styles. I know the more verbose categorization seems to be dominant, but going forward would like to create a script that can easily parse this out and enforce this style.

Revert doc on nonfunctional hosts but adjust spacing
Comment thread CONTRIBUTING.md
www.e.glavbukh.ru
Time out:
psd.glavbukh.ru
str.glavbukh.ru

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Should we use an example domain or a domain we control for this?

@zoracon zoracon Jan 21, 2021 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

We can. I can adjust to reflect that or you can.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

#19899 feel free to adjust/copy my changes.

@J0WI J0WI mentioned this pull request Jan 22, 2021
@zoracon

zoracon commented Jan 22, 2021

Copy link
Copy Markdown
Contributor Author

Merged in related PR, closing this one out

@zoracon zoracon closed this Jan 22, 2021
@zoracon
zoracon deleted the zoracon-patch-docs-1 branch June 16, 2021 04:04
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants