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

Define guidelines for compiler messages #34

Open
adamconnelly opened this issue Sep 16, 2020 · 0 comments
Open

Define guidelines for compiler messages #34

adamconnelly opened this issue Sep 16, 2020 · 0 comments

Comments

@adamconnelly
Copy link
Owner

At the moment the format of the messages for the compiler is defined here, but we should go a bit further and specify guidelines that all the messages should follow to make sure they're consistent, and also to make it easier for people to add new messages.

Some examples of what we might wanna think about are:

  • How to structure each message (e.g. Problem, Potential Solution).
  • The voice to use (e.g. "I couldn't find the 'User' type" vs "'User' could not be found").
  • Making sure to include context information where possible (e.g. "'Username' uses the slist type" vs "slist should not be used".

There's a really interesting paper written about this here: https://www.hindawi.com/journals/ahci/2010/602570/

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

1 participant