Documentation

[markashleybell]

We need:

• Actual API documentation
• More/better examples (including explanation of relative path requirements)
• Contributor guide (how to get up and running, tests etc)

[markashleybell]

This is handy! https://github.com/markashleybell/MAB.DotIgnore/community

[balanikas]

This is handy! https://github.com/markashleybell/MAB.DotIgnore/community

hey @markashleybell this might be handy too, to check the health of the repository, https://githubrepositoryanalysis.com/?url=https://github.com/markashleybell/MAB.DotIgnore

By the way, that app uses your Ignore package, which works great and thank you for that, although it hits performance issues (the regex matching part). I use it to check for .gitignore violations for public repos. For example, analyzing https://github.com/dotnet/roslyn takes several seconds and the regex matching take up the majority of that time period.

Any chance you plan to address performance for the Ignore package, or have you moved on from this project?

[markashleybell]

@balanikas Glad you're finding it useful!

With regards to maintenance, please see my reply here:

#24 (comment)

To summarise: I'm not in a position to actively maintain this project in terms of new features/improvements due to lack of free time, but minor bug fixes will be made and any pull requests are welcomed.

So, if you have any ideas on how to improve performance, please feel free to open a PR—or an issue to discuss first, if that's easier—and I'm happy to review/answer questions.