swagger-api / swagger-api/swagger-codegen
CSharp - Add // <auto-generated /> to each generated class to get Stylecop to ignore these files
Open
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Description
When we include the code gen project into our build process we get thousands of Stylecope warnings about code style.
Swagger-codegen version
Current.
Suggest a fix/enhancement
Add an option to add the following on to all class files:
//
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue names CSharp generated class files and the requested auto-generated comment, but no source files or tests. Start by locating the CSharp generation templates and checking how generated classes are assembled. Done means an option adds the comment to every generated class and StyleCop warnings are suppressed for those files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100