Guidelines: Add the entry about one-off scripts #9089
Conversation
|
Start a new ephemeral environment with changes proposed in this pull request: Fedora Environment Oracle Linux 8 Environment |
evgenyz
force-pushed
the
doc_guide_no_one-off
branch
from
0092cc8
to
b3619c0
Compare
There was a problem hiding this comment.
We could find such scripts and delete them from the project as well. For example, the csv to rule migration tool is obsolete and if anyone would still require it, they can obtain from an older release.
https://github.com/ComplianceAsCode/content/blob/master/utils/migrate_template_csv_to_rule.py
|
Files Other files don't seem to be a particularly significant pain, and they are also quite recent. |
evgenyz
force-pushed
the
doc_guide_no_one-off
branch
3 times, most recently
from
e33b62a
to
82d0ea0
Compare
|
The more I'm trying to fix mdl errors, the more errors I get (even from unrelated files). I'd say that it is good enough, since there is no more problems in the Style Guilde file. |
I agree, thank you for the PR! Could you please just rebase, so the failing test starts to pass as well? |
the entry about one-off scripts We don't want one-off stray scripts to lay around. They litter the project space. In rare cases when a script could be useful again, it could be retrieved from the history.
Blank lines around headers, lists, code-blocks.
Ignore line lengths. It is more important to have easily-redact-able sentences.
utils/migrate_template_csv_to_rule.py utils/rule_dir_diff.py utils/rule_dir_stats.py
Set lists indentation to 4 instead of default 2.
evgenyz
force-pushed
the
doc_guide_no_one-off
branch
from
82d0ea0
to
c2789f3
Compare
|
Code Climate has analyzed commit c2789f3 and detected 40 issues on this pull request. Here's the issue category breakdown:
The test coverage on the diff in this pull request is 100.0% (50% is the threshold). This pull request will bring the total coverage in the repository to 42.7% (0.0% change). View more on Code Climate. |
|
Thanks, fail on rawhide during dependency install is OK. |
Description:
Rationale:
it could be retrieved from the history.