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.

Sign up for GitHub

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

Jump to bottom

Add information that output file is generated code #30

Open
mgajda opened this issue Aug 24, 2019 · 0 comments
Open

Add information that output file is generated code #30

mgajda opened this issue Aug 24, 2019 · 0 comments
Labels
beginner enhancement patches-welcome Developers welcome patches or suggestions how it is solved in other libraries.

Comments

@mgajda
Copy link
Collaborator

mgajda commented Aug 24, 2019

In case of a big project with multiple contributors, we should follow the golden standard of handling generated code:

  1. Add a comment on top that it is generated.
  2. Add metainformation about the input from which it was generated.
  3. Add a note how to regenerate it when the source changes.
@mgajda mgajda added enhancement patches-welcome Developers welcome patches or suggestions how it is solved in other libraries. beginner labels Aug 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
beginner enhancement patches-welcome Developers welcome patches or suggestions how it is solved in other libraries.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mgajda