Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove custom build task in favor of documentation #1788

Closed
sharwell opened this issue Nov 18, 2015 · 2 comments
Closed

Remove custom build task in favor of documentation #1788

sharwell opened this issue Nov 18, 2015 · 2 comments
Assignees
Milestone

Comments

@sharwell
Copy link
Member

I think we should revert #1581 since it still results in various problems like #1684 and #1720. We originally did this and ran into problems where users did not realize manual steps were needed after applying the code fix in order for stylecop.json settings to take effect. This can be resolved by adding a comment at the top of the generated stylecop.json file:

// ACTION REQUIRED: This file was automatically added to your project, but it
// will not take effect until additional steps are taken to enable it. See the
// following page for additional information:
//
// https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/EnableConfiguration.md

📝 The page mentioned above should only contain information about enabling stylecop.json. A good starting point would be the content which was removed from Configuration.md in #1636.

📝 This is not technically valid JSON syntax, but it is supported by both the Visual Studio JSON editor and Newtonsoft.Json library we use for reading the file.

@pdelvo
Copy link
Member

pdelvo commented Nov 18, 2015

👍

@sharwell sharwell added this to the 1.0.0 Beta 16 milestone Nov 18, 2015
@vweijsters
Copy link
Contributor

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants