mozilla / acidity Goto Github PK

Or if the last tag was many commits ago?

peterbe@mpb:~$ acidity airmozilla
"dist" folder does not exist!
No LICENSE found! :-(
No README found! :-(
You have 19 files in the root directory:
maybe you can try moving your files into folders?

Tests failed: 3/3
peterbe@mpb:~$ ls airmozilla/LICENSE
airmozilla/LICENSE
peterbe@mpb:~$ ls airmozilla/README.md
airmozilla/README.md

What does the "dist" folder does not exist! mean? I guess, the issue here is that that message isn't clear.

Also, note that it failed to pick up that my project has a LICENSE file and a README.md file.

... but allow the devs to override that check for projects that don't have/need any particular directory.

Errors, etc...

Only applicable if it's a github project?

Suppose you don't want this tool to bother you about an specific test

Some things are hard to automate. For example, "name an owner/responsible person in the README file" is hard to extract programmatically.

Should we have flags inside an rc (or .json) file that tell the tool "yes, I have considered this"? That could be akin to setting jshint flags, so it recognizes/ignores certain idioms.

As of January 1 2019, Mozilla requires that all GitHub projects include this CODE_OF_CONDUCT.md file in the project root. The file has two parts:

1. Required Text - All text under the headings Community Participation Guidelines and How to Report, are required, and should not be altered.
2. Optional Text - The Project Specific Etiquette heading provides a space to speak more specifically about ways people can work effectively and inclusively together. Some examples of those can be found on the Firefox Debugger project, and Common Voice. (The optional part is commented out in the raw template file, and will not be visible until you modify and uncomment that part.)

If you have any questions about this file, or Code of Conduct policies and procedures, please see Mozilla-GitHub-Standards or email [email protected].

(Message COC001)

some natural language processing

dist/, examples/, src/, tests/ are required by default but as @fwenzel puts it in #4 (comment) some projects don't have/need any particular directory.

In a bad case... could it guess using the highest number of contributions to the git repository?

but allow devs to check it off, or point at different file to cover CI / tests.

When testing the sources for developer.mozilla.org, acidity did not recognize our README.rst file as a valid README file.

The README test should recognize any README.* file as valid.

of a substantial size.

Who tests the testers?!?!

It should iterate through the files in the tests directory

• what the project is
• how it works
• current version + changelog + roadmap
• download
• communication channels (issues/bugzilla, irc, twitter)