Merge pull request #86 from roskakori/54-detect-github-community-text…

…-files #54 Added detection of GitHub community files without suffix as text.
roskakori · Jan 5, 2022 · 40b609d · 40b609d
2 parents 6b9de2f + 87df62b
commit 40b609d
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -13,6 +13,11 @@ Version 1.3.0, 2022-xx-xx
 * Added JSON as additional output :option:`--format`, see :doc:`json` for
   details (issue `#62 <https://github.com/roskakori/pygount/issues/62>`_).
 
+* Added detection of
+  `GitHub community files <https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions>`_
+  without suffix as text (issue
+  `#54 <https://github.com/roskakori/pygount/issues/54>`_).
+
 * Changed build process to `poetry <https://python-poetry.org/>`_ to change
   several messy configuration files into a single even more messy
   configuration file.

diff --git a/pygount/analysis.py b/pygount/analysis.py
@@ -111,6 +111,13 @@ class SourceState(Enum):
     "news",
     "readme",
     "thanks",
+    # Github community recommendations, see
+    # <https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions>.
+    # By now, in practice most projects use a suffix like "*.md" but some older ones
+    # still might have such files without suffix.
+    "code_of_conduct",
+    "contributing",
+    "support",
     # Other common text files.
     "changes",
     "faq",