{"action":"created","issue":{"url":"https://api.github.com/repos/iojs/io.js/issues/1220","labels_url":"https://api.github.com/repos/iojs/io.js/issues/1220/labels{/name}","comments_url":"https://api.github.com/repos/iojs/io.js/issues/1220/comments","events_url":"https://api.github.com/repos/iojs/io.js/issues/1220/events","html_url":"https://github.com/iojs/io.js/issues/1220","id":63225041,"number":1220,"title":"Consistent error messages in all modules","user":{"login":"micnic","id":1449826,"avatar_url":"https://avatars.githubusercontent.com/u/1449826?v=3","gravatar_id":"","url":"https://api.github.com/users/micnic","html_url":"https://github.com/micnic","followers_url":"https://api.github.com/users/micnic/followers","following_url":"https://api.github.com/users/micnic/following{/other_user}","gists_url":"https://api.github.com/users/micnic/gists{/gist_id}","starred_url":"https://api.github.com/users/micnic/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/micnic/subscriptions","organizations_url":"https://api.github.com/users/micnic/orgs","repos_url":"https://api.github.com/users/micnic/repos","events_url":"https://api.github.com/users/micnic/events{/privacy}","received_events_url":"https://api.github.com/users/micnic/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/iojs/io.js/labels/discuss","name":"discuss","color":"02d7e1"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":4,"created_at":"2015-03-20T13:13:58Z","updated_at":"2015-03-20T15:30:14Z","closed_at":null,"body":"Based on PR https://github.com/iojs/io.js/pull/892 I want to propose to define some general rules for writing error messages. For the beginning, I propose the following rules:\r\n- Capitalized first word at the beginning of the message\r\n\r\n> TypeError: First argument should be a string or buffer\r\n\r\n- Quoted variable name\r\n\r\n> Error: \"name\" argument is required\r\n\r\n- Verbose message text\r\n\r\n> Error: Bad argument // instead of \"bad arg\" which is used now in [SyncWriteStream.prototype.write](https://github.com/iojs/io.js/blob/v1.x/lib/fs.js#L1888)\r\n> RangeError: \"n\" should be less than or equal to \"kMaxLength\"\r\n\r\n- Consistent usage of \"should\" vs \"must\" as mentioned by @timoxley https://github.com/iojs/io.js/pull/892#issuecomment-83751850 to follow https://tools.ietf.org/html/rfc2119\r\n\r\ncc @iojs/collaborators "},"comment":{"url":"https://api.github.com/repos/iojs/io.js/issues/comments/84049663","html_url":"https://github.com/iojs/io.js/issues/1220#issuecomment-84049663","issue_url":"https://api.github.com/repos/iojs/io.js/issues/1220","id":84049663,"user":{"login":"micnic","id":1449826,"avatar_url":"https://avatars.githubusercontent.com/u/1449826?v=3","gravatar_id":"","url":"https://api.github.com/users/micnic","html_url":"https://github.com/micnic","followers_url":"https://api.github.com/users/micnic/followers","following_url":"https://api.github.com/users/micnic/following{/other_user}","gists_url":"https://api.github.com/users/micnic/gists{/gist_id}","starred_url":"https://api.github.com/users/micnic/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/micnic/subscriptions","organizations_url":"https://api.github.com/users/micnic/orgs","repos_url":"https://api.github.com/users/micnic/repos","events_url":"https://api.github.com/users/micnic/events{/privacy}","received_events_url":"https://api.github.com/users/micnic/received_events","type":"User","site_admin":false},"created_at":"2015-03-20T15:30:14Z","updated_at":"2015-03-20T15:30:14Z","body":"@Fishrock123, I think periods are irrelevant in understanding the message of the error\r\n\r\nanother thing that I missed: error message length limit ~60 chars"}}