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

Add ruleset: chapter1.io - #15168

Merged
Bisaloo merged 2 commits into
EFForg:masterfrom
injust:patch-18
Apr 19, 2018
Merged

Bisaloo merged 2 commits into
EFForg:masterfrom
injust:patch-18

Conversation

@injust

@injust injust commented Apr 15, 2018

Copy link
Copy Markdown
Contributor

No description provided.

@@ -0,0 +1,5 @@
<ruleset name="chapter1.io">

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Please use the same case for the filename and the ruleset name. In this example, the ruleset name should be Chapter1.io

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.

Is this standard practice?
CONTRIBUTING.md gives SeattleAquarium.org.xml as an example for ruleset naming conventions, and the ruleset name doesn't match the filename.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

You are right that the contributing guide is not clear enough on that point IMO. The next section states:

Filenames should vaguely resemble the name so that someone looking for the file based on the name can find it easily.

Following that logic, ruleset name and filename should actually be exactly the same because it makes it easier to find the file when you only know the ruleset name.

Is this standard practice?

I know at least @jeremyn is also following this rule in his reviews.

@Bisaloo
Bisaloo merged commit 3fcfa0e into EFForg:master Apr 19, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants