Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Declare what files should be considered as source and documentation

See original GitHub issue

Description

Now I think there is a slight inconsistency of what files are considered as source and documentation changes.

For example: only files inside the docs folder considered as documentation changes and triggers a spell check, and any other files (e.g. .github/*, CONTRIBUTING.md, cSpell.json,…) are considered as source change.

I propose a more detailed way of this consideration.

Source changes: .nuke/**/* Build/**/* Src/**/* Tests/**/* build.* CNAME Directory.Build.props FluentAssertion.sln FluentAssertion.sln.DotSettings GitVersion.yml global.json nuget.config Rules.ruleset TestRules.ruleset

Documentation changes: docs/**/* CONTRIBUTING.md cSpell.json LICENSE README.md

Issue Analytics

State:
Created 8 months ago
Comments:6 (6 by maintainers)

Top GitHub Comments

1reaction

jnyrupcommented, Jan 14, 2023

Cool will do that…

Can I add that to #2093?

If this is ok, I will add this few lines to this PR?

No, please. It’s much easier for us to manage and review more PRs that have a narrower focus.

0reactions

IT-VBFKcommented, Jan 13, 2023

Cool will do that…

Can I add that to #2093?

If this is ok, I will add this few lines to this PR?

Top Results From Across the Web

How to Write Doc Comments for the Javadoc Tool

The JDK tool that generates API documentation from documentation comments. Source Files. The Javadoc tool can generate output originating from four different ...

Documentation - Declaration Reference

The purpose of this guide is to teach you how to write a high-quality definition file. This guide is structured by showing documentation...

Recommended XML tags for C# documentation comments

This article provides the syntax and definitions for recommended tags for XML documentation.

Content roots | IntelliJ IDEA Documentation

The IDE considers that files in the Generated Sources folder are generated automatically rather than written manually, and can be regenerated.

POM Reference - Maven

There is a Maven goal called deploy:deploy-file which is similar to the ... deploy the project source code and API docs along with...